The endpoints require a valid bearer token to access.
Information on how to generate tokens is issued by our support team.
In the examples below, the endpoints are all relative URLs.
If an example is opened in POSTMAN, a {mainUrl} variable is already prepended to the endpoints, which you will want to provide in your environment.
When calling from code, this value will want to be prepended manually.
\nThe {mainUrl} value takes the format:
{customerEclipseUrl}/ClientGateway/api/
All success responses from this API are wrapped in a common object
\nNullable long datatype
\nIndiciates the job number if the endpoint started a long running job
\nBoolean
\nIndicates if the operation performed has made changes to the data that may require a rerate. This would require a separate request to be peformed to request the rerate.
\nModel Example:
\n{\n \"ReturnModel\": <Object Returned By Endpoint>,\n \"JobNumber\": <long?>,\n \"MayRequireRerate\": false\n}\n\n\"Paged search\" is our standardised method for returning data from the API. These endpoints allow filtering by any field returned in the parent object of the response model (nested objects are not supported), and some flexibility in how these filters are combined.
This flexibility should cover most data retrieval scenarios.
Example Explanation:
\nThe example model below will result in data being returned where
\nDescription is Equal To \"London CLI\"
\nand
\nPhonenumber Contains \"020\"
\nOR
\nDescription Equal To \"Manchester CLI\"
\nand
\nPhonenumber Contains \"0161\"
\nThe example model below will sort the data by LastUpdated Descending
\nModel Example:
\n{\n \"GroupedFilterExpressions\": [\n {\n \"FilterExpressions\":\n [\n {\n \"FieldName\": \"Description\",\n \"FieldValue\": \"London CLI\",\n \"FilterFunction\": \"EqualTo\"\n },\n {\n \"FieldName\": \"Phonenumber\",\n \"FieldValue\": \"020\",\n \"FilterFunction\": \"Contains\"\n }\n ]\n },\n {\n \"FilterExpressions\":\n [\n {\n \"FieldName\": \"Description\",\n \"FieldValue\": \"Manchester CLI\",\n \"FilterFunction\": \"EqualTo\"\n },\n {\n \"FieldName\": \"Phonenumber\",\n \"FieldValue\": \"0161\",\n \"FilterFunction\": \"Contains\"\n }\n ]\n }\n ],\n \"FilterExpressionsUsingOR\": true,\n \"SortExpressions\": [\n {\n \"FieldName\": \"LastUpdated\",\n \"SortOrder\": 2\n }\n ],\n \"PageNumber\": 1,\n \"PageSize\": 500\n}\n\nMandatory
\n1 based integer
\nMandatory
\nMax 1000
\nOptional array
\nFilterExpressions
\nFilterExpressionsUsingOR
\nOptional
\nDefaults to false
\nOperates on the Filter Expressions within the group
\nOptional
\nDefaults to false
\nOperaties on the Grouped Filter Expressions
\nOptional
\nDefaults to data appropriate value (generally the id)
\nCan combine any return field
\nIndividual filter expressions allowing filtering on fields. The FilterFunction can be one of the following values:
\nContains
\nDoesNotContain
\nStartsWith
\nEndsWith
\nEqualTo
\nNotEqualTo
\nGreaterThan
\nLessThan
\nGreaterThanOrEqualTo
\nLessThanOrEqualTo
\nIsEmpty
\nNotIsEmpty
\nIsNull
\nNotIsNull
\nIn
\nExpects data in a comma delimited list
\nNon numeric fields should have values qualified with \"
\nIsNotIn
\nExpects data in a comma delimited list
\nNon numeric fields should have values qualified with \"
\nYou should consider the function you are attempting to use and whether it is appropriate for the data value you are attempting to search by.
\ni.e. If you are searching on a date field, the StartsWith filter function would not be suitable.
\nAscending = 1
\nDescending = 2
\nWhen invalid data is received, we will return it in a standardised format (HTTP 400).
This matches validation errors auto generated by the framework we use for consistency.
Model Example:
\n{\n \"type\": \"https://tools.ietf.org/html/rfc7231#section-6.5.1\",\n \"title\": \"One or more validation errors occurred.\",\n \"status\": 400,\n \"traceid\": \"\",\n \"errors\": {\n \"ErrorHeader\": [\n \"Error Description 1\",\n \"Error Description 2\"\n ],\n \"ErrorHeader2\": [\n \"Error Description 3\"\n ]\n }\n}\n\nRelevant endpoints have mandatory fields stated but may require additional fields to be provided based on validation, which may differ for each endpoint.
\nThe Eclipse APIs are constantly being developed. Where a change is made that requires an endpoint to be deprecated, a header will be included in the response indicating that the endpoint is obsolete & when it will be removed completely.
Where an alternative is available, the documenation should indicate this.
If the obsolete header is returned, on or before the date, the endpoint will continue to operate as normal.
After this date, the endpoint will return a HTTP 403 response
Example Header Value:
\n{\n \"Obsolete\": \"2024-03-26\"\n}\n\nExample 403 Response:
\n{\n \"type\": \"https://tools.ietf.org/html/rfc7231#section-6.5.1\",\n \"title\": \"One or more validation errors occurred.\",\n \"status\": 400,\n \"traceid\": \"\",\n \"errors\": {\n \"Endpoint no longer available\": [\n \"This end point is no longer accessible as the obsolete date: 2024-03-26 has passed.\"\n ]\n }\n}\n\nGets the supported account types.
\n","urlObject":{"path":["Account","GetAccountTypes"],"host":["{{mainUrl}}v1"],"query":[],"variable":[]}},"response":[{"id":"c72f6a3d-15fa-46ee-9dbe-363268d77ad1","name":"Get Account Types","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"url":"{{mainUrl}}v1/Account/GetAccountTypes"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnModel\": [\n {\n \"Id\": 0,\n \"AccountType\": \"Consumer\"\n },\n {\n \"Id\": 1,\n \"AccountType\": \"Business\"\n }\n ],\n \"JobNumber\": null,\n \"MayRequireRerate\": false\n}"}],"_postman_id":"add070cc-261e-4655-8c87-2916d0862f5f"},{"name":"Search Account Paged","id":"93ab34fb-05ff-4e90-9772-72064a171b05","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access-token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"{ \n \"GroupedFilterExpressions\": [\n {\n \"FilterExpressions\": [\n {\n \"FieldName\": \"AccountNumber\",\n \"FieldValue\": \"0A\",\n \"FilterFunction\": \"EndsWith\"\n }\n ],\n \"FilterExpressionsUsingOR\": false\n }\n ], \n \"SortExpressions\": [\n {\n \"FieldName\": \"Id\",\n \"SortOrder\": \"Descending\"\n }\n ],\n \"PageNumber\": 1,\n \"PageSize\": 100\n}"},"url":"{{mainUrl}}v1/Account/SearchAccountPaged","description":"Searches account data with pagination and sorting.
\n","urlObject":{"path":["Account","SearchAccountPaged"],"host":["{{mainUrl}}v1"],"query":[],"variable":[]}},"response":[{"id":"0b9e994f-a0c4-4d54-bd56-ebc9074b83df","name":"Search Account Paged","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"{ \n \"GroupedFilterExpressions\": [\n {\n \"FilterExpressions\": [\n {\n \"FieldName\": \"AccountNumber\",\n \"FieldValue\": \"Name\",\n \"FilterFunction\": \"EndsWith\"\n }\n ],\n \"FilterExpressionsUsingOR\": false\n }\n ], \n \"SortExpressions\": [\n {\n \"FieldName\": \"Id\",\n \"SortOrder\": \"Descending\"\n }\n ],\n \"PageNumber\": 1,\n \"PageSize\": 100\n}","options":{"raw":{"language":"json"}}},"url":"{{mainUrl}}v1/Account/SearchAccountPaged"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnModel\": {\n \"CurrentPage\": 1,\n \"TotalPages\": 1,\n \"TotalItems\": 1,\n \"ItemsPerPage\": 100,\n \"Items\": [\n {\n \"Id\": 28,\n \"AccountNumber\": \"Account Number\",\n \"AccountName\": \"Account Name\",\n \"PrimaryContactSurname\": \"Joe\",\n \"PrimaryContactForename\": \"Bloggs\",\n \"PrimaryContactJobTitle\": \"Manager\",\n \"PrimaryContactSalutation\": \"Mr\",\n \"RegisteredAddressLine1\": \"Registered Address Line 1\",\n \"RegisteredAddressLine2\": \"Registered Address Line 2\",\n \"RegisteredAddressLine3\": \"Registered Address Line 3\",\n \"RegisteredAddressPostcode\": \"Registered Address Postcode\",\n \"RegisteredAddressCounty\": \"Registered Address County\",\n \"RegisteredAddressCountry\": \"Registered Address Country\",\n \"PrimaryContactTelephoneAlt\": \"Primary Contact Telephone Alt\",\n \"AccountDetailsTelephoneMain\": \"Account Details Telephone Main\",\n \"PrimaryContactTelephoneMobile\": \"Primary Contact Telephone Mobile\",\n \"PrimaryContactExtension\": \"Primary Contact Extension\",\n \"AccountDetailsFax\": \"Account Details Fax\",\n \"AccountDetailsEmail\": \"joebloggs@informbilling.co.uk\",\n \"AccountDetailsWebsite\": \"https://www.informbilling.co.uk\",\n \"AccountCreatedBy\": \"joebloggs\",\n \"AccountStatus\": {\n \"Id\": 1,\n \"Name\": \"Open\"\n },\n \"BillingAddressLine1\": \"Billing Address Line 1\",\n \"BillingAddressLine2\": \"Billing Address Line 2\",\n \"BillingAddressLine3\": \"Billing Address Line 3\",\n \"BillingAddressPostcode\": \"Billing Address Postcode\",\n \"BillingAddressCounty\": \"Billing Address County\",\n \"BillingAddressCountry\": \"Billing Address Country\",\n \"PrimaryContactTelephoneMain\": \"Primary Contact Telephone Main\",\n \"AccountDetailsFax2\": \"HFax\",\n \"PrimaryContactBillingEmail\": \"joebloggs@informbilling.co.uk\",\n \"AccountTypeIsCustomer\": true,\n \"AccountTypeIsDealer\": true,\n \"AccountTypeIsSupplier\": true,\n \"AccountTypeIsProspect\": true,\n \"AccountTypeIsContact\": true,\n \"AccountOnStop\": true,\n \"CreditLimit\": 1,\n \"BillingAddressFao\": \"Billing Address Fao\",\n \"VatRegistered\": false,\n \"VatNo\": \"Vat No\",\n \"AccountCreatedDate\": \"2022-09-08T15:24:05.427Z\",\n \"InvoiceNo\": null,\n \"InvoiceDate\": null,\n \"AccountDetailsCompanyRegNo\": \"Account Details Company Reg No\",\n \"AccountDetailsCompanyType\": \"Account Details Company Type\",\n \"AccountDetailsYearsTrading\": 1,\n \"PaymentMethod\": 1,\n \"AccountTypeReseller\": true,\n \"EmailInvoiceToAccount\": true,\n \"SalesManager\": {\n \"Id\": 1,\n \"Name\": \"John Smith\"\n },\n \"AccountManager\": {\n \"Id\": 1,\n \"Name\": \"John Smith\"\n },\n \"CreditDays\": 30,\n \"ZipFilesAttachedForEmailInvoice\": true,\n \"MergePDFFilesForEmailInvoice\": true,\n \"UserDefinedField\": {\n \"Custom1\": \"Custom 1\",\n \"Custom2\": \"Custom 2\",\n \"Custom3\": \"Custom 3\",\n \"Custom4\": \"Custom 4\",\n \"Custom5\": \"Custom 5\",\n \"Custom6\": \"\",\n \"Custom7\": null,\n \"Custom8\": null,\n \"Custom9\": null,\n \"Custom10\": \"Custom 10\",\n \"Custom11\": null,\n \"Custom12\": null,\n \"Custom13\": null,\n \"Custom14\": null,\n \"Custom15\": null\n },\n \"ItemiseCallsWithSecondsGreaterThan\": 5,\n \"ItemiseCallsWithCostGreaterThan\": 1.2,\n \"PrintAnalysis\": true,\n \"EmailAnalysisToAccount\": true,\n \"AnalysisStyleId\": 1,\n \"AdditionalInvoiceText\": \"Additional Invoice Text\",\n \"IsPrinted\": true,\n \"ShowIntroducerOnInvoice\": true,\n \"MinimumBillValue\": 1,\n \"BillStyle\": \"Default Eclipse Style\",\n \"VatCode\": {\n \"Id\": 2,\n \"Code\": \"T1\",\n \"Rate\": 20\n },\n \"BillingCompany\": {\n \"Id\": 4,\n \"Name\": \"Template Company\"\n },\n \"AnticipatedSpend\": 1,\n \"IsUploadedToEnlighten\": true,\n \"PoNumber\": \"Po Number\",\n \"AccountReference\": \"Account Reference\",\n \"PriceList\": {\n \"Id\": 1,\n \"Name\": \"Price List 1\"\n },\n \"AdvancedMonths\": 1,\n \"ClosedDate\": null,\n \"AlertsEmail\": \"joebloggs@informbilling.co.uk\",\n \"LastUpdated\": \"2024-06-11T11:10:14.590215+01:00\"\n }\n ]\n },\n \"JobNumber\": null,\n \"MayRequireRerate\": false\n}"}],"_postman_id":"93ab34fb-05ff-4e90-9772-72064a171b05"},{"name":"Search Deleted Account Paged","id":"61dbc125-fdc8-4e4b-ad89-baba490b95db","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access-token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"{ \n \"GroupedFilterExpressions\": [\n {\n \"FilterExpressions\":\n [\n {\n \"FieldName\": \"LastUpdated\",\n \"FieldValue\": \"2025-01-01T13:48:20+00:00\",\n \"FilterFunction\": \"GreaterThanOrEqualTo\"\n }\n ],\n \"FilterExpressionsUsingOR\": false\n }\n ],\n \"SortExpressions\": [\n {\n \"FieldName\": \"Id\",\n \"SortOrder\": \"Descending\"\n }\n ],\n \"PageNumber\": 1,\n \"PageSize\": 50\n}"},"url":"{{mainUrl}}v1/Account/SearchDeletedAccountPaged","description":"Searches account data with pagination and sorting.
\n","urlObject":{"path":["Account","SearchDeletedAccountPaged"],"host":["{{mainUrl}}v1"],"query":[],"variable":[]}},"response":[{"id":"b56657d9-c380-410e-aeac-fe09e7373e43","name":"Search Deleted Account Paged","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"CustomerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"{ \n \"GroupedFilterExpressions\": [\n {\n \"FilterExpressions\":\n [\n {\n \"FieldName\": \"LastUpdated\",\n \"FieldValue\": \"2025-01-01T13:48:20+00:00\",\n \"FilterFunction\": \"GreaterThanOrEqualTo\"\n }\n ],\n \"FilterExpressionsUsingOR\": false\n }\n ],\n \"SortExpressions\": [\n {\n \"FieldName\": \"Id\",\n \"SortOrder\": \"Descending\"\n }\n ],\n \"PageNumber\": 1,\n \"PageSize\": 50\n}","options":{"raw":{"language":"json"}}},"url":"{{mainUrl}}v1/Account/SearchDeletedAccountPaged"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnModel\": {\n \"CurrentPage\": 1,\n \"TotalPages\": 1,\n \"TotalItems\": 3,\n \"ItemsPerPage\": 50,\n \"Items\": [\n {\n \"Id\": 14,\n \"AccountId\": 1387,\n \"LastUpdated\": \"2025-01-06T17:17:50.2018735+00:00\"\n },\n {\n \"Id\": 13,\n \"AccountId\": 1378,\n \"LastUpdated\": \"2025-02-10T09:22:37.7817394+00:00\"\n },\n {\n \"Id\": 12,\n \"AccountId\": 1379,\n \"LastUpdated\": \"2025-01-11T12:22:37.7817394+00:00\"\n }\n ]\n },\n \"JobNumber\": null,\n \"MayRequireRerate\": false\n}"}],"_postman_id":"61dbc125-fdc8-4e4b-ad89-baba490b95db"},{"name":"Insert Account","id":"bef2222b-c162-4bd9-a888-3ee54a644b12","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access-token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"{\n \"AccountName\": \"API Insert Account 001\",\n \"AccountNumber\": \"APITEST001\",\n \"AccountDetailsCompanyRegNo\": \"11223344\",\n \"AccountTypeIsCustomer\": true,\n \"AccountTypeIsDealer\": false,\n \"AccountTypeReseller\": false,\n \"AccountTypeIsSupplier\": false,\n \"AccountTypeIsProspect\": false,\n \"AccountTypeIsContact\": false,\n \"AccountDetailsCompanyType\": \"Account Details Company Type\",\n \"SalesManagerId\": 1,\n \"AccountManagerId\": 1,\n \"PrimaryContactSurname\": \"Bloggs\",\n \"PrimaryContactForename\": \"Joe\",\n \"PrimaryContactJobTitle\": \"Developer\",\n \"PrimaryContactSalutation\": \"Mr\",\n \"BillingAddressFao\": \"Billing Address Fao\",\n \"BillingAddressLine1\": \"Billing Address Line 1\",\n \"BillingAddressLine2\": \"Billing Address Line 2\",\n \"BillingAddressLine3\": \"Billing Address Line 3\",\n \"BillingAddressPostcode\": \"DE65 5FN\",\n \"BillingAddressCounty\": \"Billing Address County\",\n \"BillingAddressCountry\": \"Billing Address Country\",\n \"RegisteredAddressLine1\": \"Registered Address Line 1\",\n \"RegisteredAddressLine2\": \"Registered Address Line 2\",\n \"RegisteredAddressLine3\": \"Registered Address Line 3\",\n \"RegisteredAddressPostcode\": \"DE65 5FN\",\n \"RegisteredAddressCounty\": \"Registered Address County\",\n \"RegisteredAddressCountry\": \"Registered Address Country\",\n \"PrimaryContactTelephoneAlt\": \"Primary Contact Telephone Alt\",\n \"AccountDetailsTelephoneMain\": \"Account Details Telephone Main\",\n \"PrimaryContactTelephoneMobile\": \"Primary Contact Telephone Mobile\",\n \"PrimaryContactExtension\": \"001\",\n \"PrimaryContactTelephoneMain\": \"Contact Telephone Main\",\n \"AccountDetailsEmail\": \"joebloggs@informbilling.co.uk\",\n \"AccountDetailsWebsite\": \"https://www.informbilling.co.uk\",\n \"AccountDetailsFax\": \"Account Details Fax\",\n \"AccountDetailsFax2\": \"Account Details Fax 2\",\n \"CreditDays\": 14.00,\n \"CreditLimit\": 1.00,\n \"VatCodeId\": 2,\n \"PaymentMethod\": 1,\n \"AdvancedMonths\": 0,\n \"PrimaryContactBillingEmail\": \"joebloggs@informbilling.co.uk\",\n \"AccountOnStop\": false,\n \"VatRegistered\": false,\n \"VatNo\": \"Vat No\",\n \"AccountDetailsYearsTrading\": 1,\n \"AccountTypeId\": 1,\n \"BillingCompanyId\": 4,\n \"AnticipatedSpend\": 1.00,\n \"PoNumber\": \"Po Number\",\n \"AccountReference\": \"Account Reference\",\n \"AlertsEmail\": \"joebloggs@informbilling.co.uk\",\n \"UserDefinedField\": {\n \"Custom1\": \"Custom1 Inserted\",\n \"Custom3\": \"Custom3 Inserted\",\n \"Custom5\": \"Custom5 Inserted\",\n \"Custom7\": \"VIP Customer\",\n \"Custom9\": \"Female\",\n \"Custom11\": \"Yes\"\n },\n \"AccountCreatedBy\": \"JoeBloggs\",\n \"AccountProfileId\": 4\n}\n"},"url":"{{mainUrl}}v1/Account/InsertAccount","description":"Inserts account record using account profile id. Custom fields are required to be provided based on setup.
\nBelow is a list of mandatory fields:
\n","urlObject":{"path":["Account","InsertAccount"],"host":["{{mainUrl}}v1"],"query":[],"variable":[]}},"response":[{"id":"b283084b-182a-46f0-86ac-f4805f3d0319","name":"Insert Account","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"{\n \"AccountName\": \"API Insert Account 001\",\n \"AccountNumber\": \"APITEST001\",\n \"AccountDetailsCompanyRegNo\": \"11223344\",\n \"AccountTypeIsCustomer\": true,\n \"AccountTypeIsDealer\": false,\n \"AccountTypeReseller\": false,\n \"AccountTypeIsSupplier\": false,\n \"AccountTypeIsProspect\": false,\n \"AccountTypeIsContact\": false,\n \"AccountDetailsCompanyType\": \"Account Details Company Type\",\n \"SalesManagerId\": 1,\n \"AccountManagerId\": 1,\n \"PrimaryContactSurname\": \"Bloggs\",\n \"PrimaryContactForename\": \"Joe\",\n \"PrimaryContactJobTitle\": \"Developer\",\n \"PrimaryContactSalutation\": \"Mr\",\n \"BillingAddressFao\": \"Billing Address Fao\",\n \"BillingAddressLine1\": \"Billing Address Line 1\",\n \"BillingAddressLine2\": \"Billing Address Line 2\",\n \"BillingAddressLine3\": \"Billing Address Line 3\",\n \"BillingAddressPostcode\": \"DE65 5FN\",\n \"BillingAddressCounty\": \"Billing Address County\",\n \"BillingAddressCountry\": \"Billing Address Country\",\n \"RegisteredAddressLine1\": \"Registered Address Line 1\",\n \"RegisteredAddressLine2\": \"Registered Address Line 2\",\n \"RegisteredAddressLine3\": \"Registered Address Line 3\",\n \"RegisteredAddressPostcode\": \"DE65 5FN\",\n \"RegisteredAddressCounty\": \"Registered Address County\",\n \"RegisteredAddressCountry\": \"Registered Address Country\",\n \"PrimaryContactTelephoneAlt\": \"Primary Contact Telephone Alt\",\n \"AccountDetailsTelephoneMain\": \"Account Details Telephone Main\",\n \"PrimaryContactTelephoneMobile\": \"Primary Contact Telephone Mobile\",\n \"PrimaryContactExtension\": \"001\",\n \"PrimaryContactTelephoneMain\": \"Contact Telephone Main\",\n \"AccountDetailsEmail\": \"joebloggs@informbilling.co.uk\",\n \"AccountDetailsWebsite\": \"https://www.informbilling.co.uk\",\n \"AccountDetailsFax\": \"Account Details Fax\",\n \"AccountDetailsFax2\": \"Account Details Fax 2\",\n \"CreditDays\": 14.00,\n \"CreditLimit\": 1.00,\n \"VatCodeId\": 2,\n \"PaymentMethod\": 1,\n \"AdvancedMonths\": 0,\n \"PrimaryContactBillingEmail\": \"joebloggs@informbilling.co.uk\",\n \"AccountOnStop\": false,\n \"VatRegistered\": false,\n \"VatNo\": \"Vat No\",\n \"AccountDetailsYearsTrading\": 1,\n \"AccountTypeId\": 1,\n \"BillingCompanyId\": 4,\n \"AnticipatedSpend\": 1.00,\n \"PoNumber\": \"Po Number\",\n \"AccountReference\": \"Account Reference\",\n \"AlertsEmail\": \"joebloggs@informbilling.co.uk\",\n \"UserDefinedField\": {\n \"Custom1\": \"Custom1 Inserted\",\n \"Custom3\": \"Custom3 Inserted\",\n \"Custom5\": \"Custom5 Inserted\",\n \"Custom7\": \"VIP Customer\",\n \"Custom9\": \"Female\",\n \"Custom11\": \"Yes\"\n },\n \"AccountCreatedBy\": \"JoeBloggs\",\n \"AccountProfileId\": 4\n}\n","options":{"raw":{"language":"json"}}},"url":"{{mainUrl}}v1/Account/InsertAccount"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnModel\": {\n \"Id\": 6883,\n \"AccountNumber\": \"APITEST001\",\n \"AccountName\": \"API Insert Account Test 001\",\n \"PrimaryContactSurname\": \"Bloggs\",\n \"PrimaryContactForename\": \"Joe\",\n \"PrimaryContactJobTitle\": \"Developer\",\n \"PrimaryContactSalutation\": \"Mr\",\n \"RegisteredAddressLine1\": \"Registered Address Line 1\",\n \"RegisteredAddressLine2\": \"Registered Address Line 2\",\n \"RegisteredAddressLine3\": \"Registered Address Line 3\",\n \"RegisteredAddressPostcode\": \"DE65 5FN\",\n \"RegisteredAddressCounty\": \"Registered Address County\",\n \"RegisteredAddressCountry\": \"Registered Address Country\",\n \"PrimaryContactTelephoneAlt\": \"Primary Contact Telephone Alt\",\n \"AccountDetailsTelephoneMain\": \"Account Details Telephone Main\",\n \"PrimaryContactTelephoneMobile\": \"Primary Contact Telephone Mobile\",\n \"PrimaryContactExtension\": \"001\",\n \"AccountDetailsFax\": \"Account Details Fax\",\n \"AccountDetailsEmail\": \"joebloggs@informbilling.co.uk\",\n \"AccountDetailsWebsite\": \"https://www.informbilling.co.uk\",\n \"AccountCreatedBy\": \"JoeBloggs\",\n \"AccountStatus\": {\n \"Id\": 1,\n \"Name\": \"Open\"\n },\n \"BillingAddressLine1\": \"Billing Address Line 1\",\n \"BillingAddressLine2\": \"Billing Address Line 2\",\n \"BillingAddressLine3\": \"Billing Address Line 3\",\n \"BillingAddressPostcode\": \"DE65 5FN\",\n \"BillingAddressCounty\": \"Billing Address County\",\n \"BillingAddressCountry\": \"Billing Address Country\",\n \"PrimaryContactTelephoneMain\": \"Contact Telephone Main\",\n \"AccountDetailsFax2\": \"Account Details Fax 2\",\n \"PrimaryContactBillingEmail\": \"joebloggs@informbilling.co.uk\",\n \"AccountTypeIsCustomer\": true,\n \"AccountTypeIsDealer\": false,\n \"AccountTypeIsSupplier\": false,\n \"AccountTypeIsProspect\": false,\n \"AccountTypeIsContact\": false,\n \"AccountOnStop\": false,\n \"CreditLimit\": 1.0000,\n \"BillingAddressFao\": \"Billing Address Fao\",\n \"VatRegistered\": false,\n \"VatNo\": \"Vat No\",\n \"AccountCreatedDate\": \"2024-09-02T10:06:56.06Z\",\n \"InvoiceNo\": null,\n \"InvoiceDate\": null,\n \"AccountDetailsCompanyRegNo\": \"11223344\",\n \"AccountDetailsCompanyType\": \"Account Details Company Type\",\n \"AccountDetailsYearsTrading\": 1,\n \"PaymentMethod\": 1,\n \"AccountTypeReseller\": false,\n \"EmailInvoiceToAccount\": true,\n \"SalesManager\": {\n \"Id\": 1,\n \"Name\": \"Joe Bloggs\"\n },\n \"AccountManager\": {\n \"Id\": 1,\n \"Name\": \"Joe Bloggs\"\n },\n \"CreditDays\": 14.0000,\n \"ZipFilesAttachedForEmailInvoice\": false,\n \"MergePDFFilesForEmailInvoice\": true,\n \"UserDefinedField\": {\n \"Custom1\": \"Custom1 Inserted\",\n \"Custom2\": null,\n \"Custom3\": \"Custom3 Inserted\",\n \"Custom4\": null,\n \"Custom5\": \"Custom5 Inserted\",\n \"Custom6\": null,\n \"Custom7\": \"VIP Customer\",\n \"Custom8\": null,\n \"Custom9\": \"Female\",\n \"Custom10\": null,\n \"Custom11\": \"Yes\",\n \"Custom12\": null,\n \"Custom13\": null,\n \"Custom14\": null,\n \"Custom15\": null\n },\n \"ItemiseCallsWithSecondsGreaterThan\": 0,\n \"ItemiseCallsWithCostGreaterThan\": 0.0000,\n \"PrintAnalysis\": false,\n \"EmailAnalysisToAccount\": false,\n \"AnalysisStyleId\": 1,\n \"AdditionalInvoiceText\": null,\n \"IsPrinted\": false,\n \"ShowIntroducerOnInvoice\": false,\n \"MinimumBillValue\": 0.0000,\n \"BillStyle\": \"SOHO Style\",\n \"VatCode\": {\n \"Id\": 2,\n \"Code\": \"T1\",\n \"Rate\": 20.0000\n },\n \"BillingCompany\": {\n \"Id\": 4,\n \"Name\": \"Template Company\"\n },\n \"AnticipatedSpend\": 1.0000,\n \"PoNumber\": \"Po Number\",\n \"AccountReference\": \"Account Reference\",\n \"PriceList\": {\n \"Id\": 1,\n \"Name\": \"Price List 1\"\n },\n \"AdvancedMonths\": 0,\n \"ClosedDate\": null,\n \"AlertsEmail\": \"joebloggs@informbilling.co.uk\",\n \"LastUpdated\": \"2024-09-02T10:06:56.0588436+01:00\"\n },\n \"JobNumber\": null,\n \"MayRequireRerate\": false\n}"}],"_postman_id":"bef2222b-c162-4bd9-a888-3ee54a644b12"},{"name":"Update Account Primary Detail","id":"cfb1c48f-a1d7-41da-b997-078c899e1e77","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access-token}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"{\r\n \"Id\": 6883,\r\n \"AccountName\": \"API Updated Account 001\",\r\n \"AccountNumber\": \"APITEST001a\",\r\n \"AccountDetailsCompanyRegNo\": \"11223344a\",\r\n \"AccountTypeIsCustomer\": false,\r\n \"AccountTypeReseller\": true,\r\n \"AccountTypeIsSupplier\": true,\r\n \"AccountTypeIsProspect\": true,\r\n \"AccountTypeIsContact\": true,\r\n \"AccountDetailsCompanyType\": \"Account Details Company Type Updated\",\r\n \"SalesManagerId\": 3,\r\n \"AccountManagerId\": 2,\r\n \"PrimaryContactSurname\": \"Doe\",\r\n \"PrimaryContactForename\": \"Samantha\",\r\n \"PrimaryContactJobTitle\": \"Teacher\",\r\n \"PrimaryContactSalutation\": \"Miss\",\r\n \"BillingAddressFao\": \"Billing Address Fao Updated\",\r\n \"BillingAddressLine1\": \"Billing Address Line 1 Updated\",\r\n \"BillingAddressLine2\": \"Billing Address Line 2 Updated\",\r\n \"BillingAddressLine3\": \"Billing Address Line 3 Updated\",\r\n \"BillingAddressPostcode\": \"DE65 5FN\",\r\n \"BillingAddressCounty\": \"Billing Address County Updated\",\r\n \"BillingAddressCountry\": \"United Kingdom Updated\",\r\n \"RegisteredAddressLine1\": \"Registered Address Line 1 Updated\",\r\n \"RegisteredAddressLine2\": \"Registered Address Line 2 Updated\",\r\n \"RegisteredAddressLine3\": \"Registered Address Line 3 Updated\",\r\n \"RegisteredAddressPostcode\": \"DE65 5FN\",\r\n \"RegisteredAddressCounty\": \"Registered Address County Updated\",\r\n \"RegisteredAddressCountry\": \"Registered Address Country Updated\",\r\n \"PrimaryContactTelephoneAlt\": \"Primary Contact Telephone Alt Updated\",\r\n \"AccountDetailsTelephoneMain\": \"Account Details Telephone Main Updated\",\r\n \"PrimaryContactTelephoneMobile\": \"Updated Contact Telephone Mobile Updated\",\r\n \"PrimaryContactExtension\": \"002\",\r\n \"PrimaryContactTelephoneMain\": \"Contact Telephone Main a\",\r\n \"AccountDetailsEmail\": \"samanthadoe@informbilling.co.uk\",\r\n \"AccountDetailsWebsite\": \"https://www.informbilling.co.uk/home\",\r\n \"AccountDetailsFax\": \"Account Details Fax Updated\",\r\n \"AccountDetailsFax2\": \"Account Details Fax 2a\",\r\n \"PrimaryContactBillingEmail\": \"samanthadoe@informbilling.co.uk\",\r\n \"AccountDetailsYearsTrading\": 2, \r\n \"AccountTypeId\": 1,\r\n \"BillingCompanyId\": 5,\r\n \"AlertsEmail\": \"samanthadoe@informbilling.co.uk\",\r\n \"ShowIntroducerOnInvoice\": false\r\n}\r\n"},"url":"{{mainUrl}}v1/Account/UpdateAccountPrimaryDetail","description":"Update account record for the primary detail fields by id.
\nBelow is a list of mandatory fields. *Note that any non-mandatory fields not supplied in the model will be submitted with default values - as such any previously supplied values would be overwritten.
\n","urlObject":{"path":["Account","UpdateAccountPrimaryDetail"],"host":["{{mainUrl}}v1"],"query":[],"variable":[]}},"response":[{"id":"ddec0f91-5e6e-4a94-b11f-ae9f2150ed72","name":"Update Account Primary Detail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"{\r\n \"Id\": 6883,\r\n \"AccountName\": \"API Updated Account 001\",\r\n \"AccountNumber\": \"APITEST001a\",\r\n \"AccountDetailsCompanyRegNo\": \"11223344a\",\r\n \"AccountTypeIsCustomer\": false,\r\n \"AccountTypeReseller\": true,\r\n \"AccountTypeIsSupplier\": true,\r\n \"AccountTypeIsProspect\": true,\r\n \"AccountTypeIsContact\": true,\r\n \"AccountDetailsCompanyType\": \"Account Details Company Type Updated\",\r\n \"SalesManagerId\": 3,\r\n \"AccountManagerId\": 2,\r\n \"PrimaryContactSurname\": \"Doe\",\r\n \"PrimaryContactForename\": \"Samantha\",\r\n \"PrimaryContactJobTitle\": \"Teacher\",\r\n \"PrimaryContactSalutation\": \"Miss\",\r\n \"BillingAddressFao\": \"Billing Address Fao Updated\",\r\n \"BillingAddressLine1\": \"Billing Address Line 1 Updated\",\r\n \"BillingAddressLine2\": \"Billing Address Line 2 Updated\",\r\n \"BillingAddressLine3\": \"Billing Address Line 3 Updated\",\r\n \"BillingAddressPostcode\": \"DE65 5FN\",\r\n \"BillingAddressCounty\": \"Billing Address County Updated\",\r\n \"BillingAddressCountry\": \"United Kingdom Updated\",\r\n \"RegisteredAddressLine1\": \"Registered Address Line 1 Updated\",\r\n \"RegisteredAddressLine2\": \"Registered Address Line 2 Updated\",\r\n \"RegisteredAddressLine3\": \"Registered Address Line 3 Updated\",\r\n \"RegisteredAddressPostcode\": \"DE65 5FN\",\r\n \"RegisteredAddressCounty\": \"Registered Address County Updated\",\r\n \"RegisteredAddressCountry\": \"Registered Address Country Updated\",\r\n \"PrimaryContactTelephoneAlt\": \"Primary Contact Telephone Alt Updated\",\r\n \"AccountDetailsTelephoneMain\": \"Account Details Telephone Main Updated\",\r\n \"PrimaryContactTelephoneMobile\": \"Updated Contact Telephone Mobile Updated\",\r\n \"PrimaryContactExtension\": \"002\",\r\n \"PrimaryContactTelephoneMain\": \"Contact Telephone Main a\",\r\n \"AccountDetailsEmail\": \"samanthadoe@informbilling.co.uk\",\r\n \"AccountDetailsWebsite\": \"https://www.informbilling.co.uk/home\",\r\n \"AccountDetailsFax\": \"Account Details Fax Updated\",\r\n \"AccountDetailsFax2\": \"Account Details Fax 2a\",\r\n \"PrimaryContactBillingEmail\": \"samanthadoe@informbilling.co.uk\",\r\n \"AccountDetailsYearsTrading\": 2, \r\n \"AccountTypeId\": 1,\r\n \"BillingCompanyId\": 5,\r\n \"AlertsEmail\": \"samanthadoe@informbilling.co.uk\",\r\n \"ShowIntroducerOnInvoice\": false\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{mainUrl}}v1/Account/UpdateAccountPrimaryDetail"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\r\n \"ReturnModel\": {\r\n \"Id\": 6883,\r\n \"AccountNumber\": \"APITEST001a\",\r\n \"AccountName\": \"API Updated Account 001\",\r\n \"PrimaryContactSurname\": \"Doe\",\r\n \"PrimaryContactForename\": \"Samantha\",\r\n \"PrimaryContactJobTitle\": \"Teacher\",\r\n \"PrimaryContactSalutation\": \"Miss\",\r\n \"RegisteredAddressLine1\": \"Registered Address Line 1 Updated\",\r\n \"RegisteredAddressLine2\": \"Registered Address Line 2 Updated\",\r\n \"RegisteredAddressLine3\": \"Registered Address Line 3 Updated\",\r\n \"RegisteredAddressPostcode\": \"DE65 5FN\",\r\n \"RegisteredAddressCounty\": \"Registered Address County Updated\",\r\n \"RegisteredAddressCountry\": \"Registered Address Country Updated\",\r\n \"PrimaryContactTelephoneAlt\": \"Primary Contact Telephone Alt Updated\",\r\n \"AccountDetailsTelephoneMain\": \"Account Details Telephone Main Updated\",\r\n \"PrimaryContactTelephoneMobile\": \"Updated Contact Telephone Mobile Updated\",\r\n \"PrimaryContactExtension\": \"002\",\r\n \"AccountDetailsFax\": \"Account Details Fax Updated\",\r\n \"AccountDetailsEmail\": \"samanthadoe@informbilling.co.uk\",\r\n \"AccountDetailsWebsite\": \"https://www.informbilling.co.uk/home\",\r\n \"AccountCreatedBy\": \"Bob\",\r\n \"AccountStatus\": {\r\n \"Id\": 1,\r\n \"Name\": \"Open\"\r\n },\r\n \"BillingAddressLine1\": \"Billing Address Line 1 Updated\",\r\n \"BillingAddressLine2\": \"Billing Address Line 2 Updated\",\r\n \"BillingAddressLine3\": \"Billing Address Line 3 Updated\",\r\n \"BillingAddressPostcode\": \"DE65 5FN\",\r\n \"BillingAddressCounty\": \"Billing Address County Updated\",\r\n \"BillingAddressCountry\": \"United Kingdom Updated\",\r\n \"PrimaryContactTelephoneMain\": \"Contact Telephone Main a\",\r\n \"AccountDetailsFax2\": \"Account Details Fax 2a\",\r\n \"PrimaryContactBillingEmail\": \"joebloggs@informbilling.co.uk\",\r\n \"AccountTypeIsCustomer\": true,\r\n \"AccountTypeIsDealer\": false,\r\n \"AccountTypeIsSupplier\": false,\r\n \"AccountTypeIsProspect\": false,\r\n \"AccountTypeIsContact\": false,\r\n \"AccountOnStop\": false,\r\n \"CreditLimit\": 1.2000,\r\n \"BillingAddressFao\": \"Billing Address Fao Updated\",\r\n \"VatRegistered\": false,\r\n \"VatNo\": \"Vat No\",\r\n \"AccountCreatedDate\": \"2024-08-21T16:51:49.72Z\",\r\n \"InvoiceNo\": null,\r\n \"InvoiceDate\": null,\r\n \"AccountDetailsCompanyRegNo\": \"11223344a\",\r\n \"AccountDetailsCompanyType\": \"Account Details Company Type Updated\",\r\n \"AccountDetailsYearsTrading\": 2,\r\n \"PaymentMethod\": 1,\r\n \"AccountTypeReseller\": false,\r\n \"EmailInvoiceToAccount\": true,\r\n \"SalesManager\": {\r\n \"Id\": 3,\r\n \"Name\": \"Sales Manager Jane\"\r\n },\r\n \"AccountManager\": {\r\n \"Id\": 2,\r\n \"Name\": \"Acccount Manager Alice\"\r\n },\r\n \"CreditDays\": 14.0000,\r\n \"ZipFilesAttachedForEmailInvoice\": true,\r\n \"MergePDFFilesForEmailInvoice\": true,\r\n \"UserDefinedField\": {\r\n \"Custom1\": \"Custom1 Inserted\",\r\n \"Custom2\": null,\r\n \"Custom3\": \"Custom3 Inserted\",\r\n \"Custom4\": null,\r\n \"Custom5\": \"Custom5 Inserted\",\r\n \"Custom6\": null,\r\n \"Custom7\": \"VIP Customer\",\r\n \"Custom8\": null,\r\n \"Custom9\": \"Female\",\r\n \"Custom10\": null,\r\n \"Custom11\": \"Yes\",\r\n \"Custom12\": null,\r\n \"Custom13\": null,\r\n \"Custom14\": null,\r\n \"Custom15\": null\r\n },\r\n \"ItemiseCallsWithSecondsGreaterThan\": 5,\r\n \"ItemiseCallsWithCostGreaterThan\": 0.4560,\r\n \"PrintAnalysis\": true,\r\n \"EmailAnalysisToAccount\": true,\r\n \"AnalysisStyleId\": 1,\r\n \"AdditionalInvoiceText\": null,\r\n \"IsPrinted\": false,\r\n \"ShowIntroducerOnInvoice\": false,\r\n \"MinimumBillValue\": 0.0000,\r\n \"BillStyle\": \"SME Style\",\r\n \"VatCode\": {\r\n \"Id\": 2,\r\n \"Code\": \"T1\",\r\n \"Rate\": 20.0000\r\n },\r\n \"BillingCompany\": {\r\n \"Id\": 5,\r\n \"Name\": \"Template Company 02\"\r\n },\r\n \"AnticipatedSpend\": 1.0000,\r\n \"PoNumber\": \"Po Number\",\r\n \"AccountReference\": \"Account Reference\",\r\n \"PriceList\": {\r\n \"Id\": 1,\r\n \"Name\": \"Price List 1\"\r\n },\r\n \"AdvancedMonths\": 0,\r\n \"ClosedDate\": null,\r\n \"AlertsEmail\": \"samanthadoe@informbilling.co.uk\",\r\n \"LastUpdated\": \"2024-09-02T10:58:28.8314957+01:00\"\r\n },\r\n \"JobNumber\": null,\r\n \"MayRequireRerate\": false\r\n}"}],"_postman_id":"cfb1c48f-a1d7-41da-b997-078c899e1e77"},{"name":"Update Account Financial","id":"3634974c-33f7-47a5-879f-7edb6812a7c2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access-token}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"{\r\n \"Id\": 6883,\r\n \"CreditDays\": 21.0,\r\n \"CreditLimit\": 125000.00,\r\n \"PaymentMethod\": 5,\r\n \"AdvancedMonths\": 0,\r\n \"AccountOnStop\": false,\r\n \"VatCodeId\": 1,\r\n \"VatRegistered\": false,\r\n \"VatNo\": \"Vat No Updated\",\r\n \"AnticipatedSpend\": 99800.55,\r\n \"MinimumBillValue\": 999.99\r\n}\r\n"},"url":"{{mainUrl}}v1/Account/UpdateAccountFinancial","description":"Update account record for the financial fields by id.
\nBelow is a list of mandatory fields. *Note that any non-mandatory fields not supplied in the model will be submitted with default values - as such any previously supplied values would be overwritten.
\n","urlObject":{"path":["Account","UpdateAccountFinancial"],"host":["{{mainUrl}}v1"],"query":[],"variable":[]}},"response":[{"id":"48437c35-c205-40c3-aba8-df95797a5243","name":"Update Account Financial","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"{\r\n \"Id\": 6883,\r\n \"CreditDays\": 21.0,\r\n \"CreditLimit\": 125000.00,\r\n \"PaymentMethod\": 5,\r\n \"AdvancedMonths\": 0,\r\n \"AccountOnStop\": false,\r\n \"VatCodeId\": 1,\r\n \"VatRegistered\": false,\r\n \"VatNo\": \"Vat No Updated\",\r\n \"AnticipatedSpend\": 99800.55,\r\n \"MinimumBillValue\": 999.99\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{mainUrl}}v1/Account/UpdateAccountFinancial"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\r\n \"ReturnModel\": {\r\n \"Id\": 6883,\r\n \"AccountNumber\": \"APITEST001a\",\r\n \"AccountName\": \"API Updated Account 001\",\r\n \"PrimaryContactSurname\": \"Doe\",\r\n \"PrimaryContactForename\": \"Samantha\",\r\n \"PrimaryContactJobTitle\": \"Teacher\",\r\n \"PrimaryContactSalutation\": \"Miss\",\r\n \"RegisteredAddressLine1\": \"Registered Address Line 1 Updated\",\r\n \"RegisteredAddressLine2\": \"Registered Address Line 2 Updated\",\r\n \"RegisteredAddressLine3\": \"Registered Address Line 3 Updated\",\r\n \"RegisteredAddressPostcode\": \"DE65 5FN\",\r\n \"RegisteredAddressCounty\": \"Registered Address County Updated\",\r\n \"RegisteredAddressCountry\": \"Registered Address Country Updated\",\r\n \"PrimaryContactTelephoneAlt\": \"Primary Contact Telephone Alt Updated\",\r\n \"AccountDetailsTelephoneMain\": \"Account Details Telephone Main Updated\",\r\n \"PrimaryContactTelephoneMobile\": \"Updated Contact Telephone Mobile Updated\",\r\n \"PrimaryContactExtension\": \"002\",\r\n \"AccountDetailsFax\": \"Account Details Fax Updated\",\r\n \"AccountDetailsEmail\": \"samanthadoe@informbilling.co.uk\",\r\n \"AccountDetailsWebsite\": \"https://www.informbilling.co.uk/home\",\r\n \"AccountCreatedBy\": \"Bob\",\r\n \"AccountStatus\": {\r\n \"Id\": 1,\r\n \"Name\": \"Open\"\r\n },\r\n \"BillingAddressLine1\": \"Billing Address Line 1 Updated\",\r\n \"BillingAddressLine2\": \"Billing Address Line 2 Updated\",\r\n \"BillingAddressLine3\": \"Billing Address Line 3 Updated\",\r\n \"BillingAddressPostcode\": \"DE65 5FN\",\r\n \"BillingAddressCounty\": \"Billing Address County Updated\",\r\n \"BillingAddressCountry\": \"United Kingdom Updated\",\r\n \"PrimaryContactTelephoneMain\": \"Contact Telephone Main a\",\r\n \"AccountDetailsFax2\": \"Account Details Fax 2a\",\r\n \"PrimaryContactBillingEmail\": \"joebloggs@informbilling.co.uk\",\r\n \"AccountTypeIsCustomer\": true,\r\n \"AccountTypeIsDealer\": false,\r\n \"AccountTypeIsSupplier\": false,\r\n \"AccountTypeIsProspect\": false,\r\n \"AccountTypeIsContact\": false,\r\n \"AccountOnStop\": false,\r\n \"CreditLimit\": 125000.0000,\r\n \"BillingAddressFao\": \"Billing Address Fao Updated\",\r\n \"VatRegistered\": false,\r\n \"VatNo\": \"Vat No Updated\",\r\n \"AccountCreatedDate\": \"2024-08-21T16:51:49.72Z\",\r\n \"InvoiceNo\": null,\r\n \"InvoiceDate\": null,\r\n \"AccountDetailsCompanyRegNo\": \"11223344a\",\r\n \"AccountDetailsCompanyType\": \"Account Details Company Type Updated\",\r\n \"AccountDetailsYearsTrading\": 2,\r\n \"PaymentMethod\": 5,\r\n \"AccountTypeReseller\": false,\r\n \"EmailInvoiceToAccount\": true,\r\n \"SalesManager\": {\r\n \"Id\": 3,\r\n \"Name\": \"Sales Manager Jane\"\r\n },\r\n \"AccountManager\": {\r\n \"Id\": 2,\r\n \"Name\": \"Acccount Manager Alice\"\r\n },\r\n \"CreditDays\": 21.0000,\r\n \"ZipFilesAttachedForEmailInvoice\": true,\r\n \"MergePDFFilesForEmailInvoice\": true,\r\n \"UserDefinedField\": {\r\n \"Custom1\": \"Custom 1\",\r\n \"Custom2\": \"Custom 2\",\r\n \"Custom3\": \"Custom 3\",\r\n \"Custom4\": \"Custom 4\",\r\n \"Custom5\": \"Custom 5\",\r\n \"Custom6\": \"\",\r\n \"Custom7\": null,\r\n \"Custom8\": null,\r\n \"Custom9\": null,\r\n \"Custom10\": \"Custom 10\",\r\n \"Custom11\": null,\r\n \"Custom12\": null,\r\n \"Custom13\": null,\r\n \"Custom14\": null,\r\n \"Custom15\": null\r\n },\r\n \"ItemiseCallsWithSecondsGreaterThan\": 5,\r\n \"ItemiseCallsWithCostGreaterThan\": 0.4560,\r\n \"PrintAnalysis\": true,\r\n \"EmailAnalysisToAccount\": true,\r\n \"AnalysisStyleId\": 1,\r\n \"AdditionalInvoiceText\": null,\r\n \"IsPrinted\": false,\r\n \"ShowIntroducerOnInvoice\": false,\r\n \"MinimumBillValue\": 999.9900,\r\n \"BillStyle\": \"SME Style\",\r\n \"VatCode\": {\r\n \"Id\": 1,\r\n \"Code\": \"T0\",\r\n \"Rate\": 0.0000\r\n },\r\n \"BillingCompany\": {\r\n \"Id\": 5,\r\n \"Name\": \"Template Company 02\"\r\n },\r\n \"AnticipatedSpend\": 99800.5500,\r\n \"PoNumber\": \"Po Number\",\r\n \"AccountReference\": \"Account Reference\",\r\n \"PriceList\": {\r\n \"Id\": 1,\r\n \"Name\": \"Price List 1\"\r\n },\r\n \"AdvancedMonths\": 0,\r\n \"ClosedDate\": null,\r\n \"AlertsEmail\": \"samanthadoe@informbilling.co.uk\",\r\n \"LastUpdated\": \"2024-09-02T11:00:49.8620416+01:00\"\r\n },\r\n \"JobNumber\": null,\r\n \"MayRequireRerate\": false\r\n}"}],"_postman_id":"3634974c-33f7-47a5-879f-7edb6812a7c2"},{"name":"Update Account User Defined Field","id":"fd1444f7-45d8-4787-b8f7-43c2d2dc0539","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access-token}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"{\r\n \"AccountId\": 28,\r\n \"Custom1\": \"Custom 1 Client Gateway Updated\",\r\n \"Custom3\": \"Custom 3 Client Gateway Updated\",\r\n \"Custom5\": \"Custom 5 Client Gateway Updated\",\r\n \"Custom7\": \"Standard Customer\",\r\n \"Custom9\": \"Male\",\r\n \"Custom11\": \"No\"\r\n}\r\n"},"url":"{{mainUrl}}v1/Account/UpdateAccountUserDefinedField","description":"Update account record for the user defined fields/custom fields by id based on setup.
\nMandatory fields for this endpoint are based on custom field/UDF setup, a 'Get Account Custom Fields' endpoint exists to retrieve this information.
\n","urlObject":{"path":["Account","UpdateAccountUserDefinedField"],"host":["{{mainUrl}}v1"],"query":[],"variable":[]}},"response":[{"id":"e8c96faa-083d-4a3a-aa12-55aed2ca548d","name":"Update Account User Defined Field","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"{\r\n \"AccountId\": 28,\r\n \"Custom1\": \"Custom 1 Client Gateway Updated\",\r\n \"Custom3\": \"Custom 3 Client Gateway Updated\",\r\n \"Custom5\": \"Custom 5 Client Gateway Updated\",\r\n \"Custom7\": \"Standard Customer\",\r\n \"Custom9\": \"Male\",\r\n \"Custom11\": \"No\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{mainUrl}}v1/Account/UpdateAccountUserDefinedField"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\r\n \"ReturnModel\": {\r\n \"Id\": 28,\r\n \"AccountNumber\": \"APITEST001a\",\r\n \"AccountName\": \"API Updated Account 001\",\r\n \"PrimaryContactSurname\": \"Doe\",\r\n \"PrimaryContactForename\": \"Samantha\",\r\n \"PrimaryContactJobTitle\": \"Teacher\",\r\n \"PrimaryContactSalutation\": \"Miss\",\r\n \"RegisteredAddressLine1\": \"Registered Address Line 1 Updated\",\r\n \"RegisteredAddressLine2\": \"Registered Address Line 2 Updated\",\r\n \"RegisteredAddressLine3\": \"Registered Address Line 3 Updated\",\r\n \"RegisteredAddressPostcode\": \"DE65 5FN\",\r\n \"RegisteredAddressCounty\": \"Registered Address County Updated\",\r\n \"RegisteredAddressCountry\": \"Registered Address Country Updated\",\r\n \"PrimaryContactTelephoneAlt\": \"Primary Contact Telephone Alt Updated\",\r\n \"AccountDetailsTelephoneMain\": \"Account Details Telephone Main Updated\",\r\n \"PrimaryContactTelephoneMobile\": \"Updated Contact Telephone Mobile Updated\",\r\n \"PrimaryContactExtension\": \"002\",\r\n \"AccountDetailsFax\": \"Account Details Fax Updated\",\r\n \"AccountDetailsEmail\": \"samanthadoe@informbilling.co.uk\",\r\n \"AccountDetailsWebsite\": \"https://www.informbilling.co.uk/home\",\r\n \"AccountCreatedBy\": \"Bob\",\r\n \"AccountStatus\": {\r\n \"Id\": 1,\r\n \"Name\": \"Open\"\r\n },\r\n \"BillingAddressLine1\": \"Billing Address Line 1 Updated\",\r\n \"BillingAddressLine2\": \"Billing Address Line 2 Updated\",\r\n \"BillingAddressLine3\": \"Billing Address Line 3 Updated\",\r\n \"BillingAddressPostcode\": \"DE65 5FN\",\r\n \"BillingAddressCounty\": \"Billing Address County Updated\",\r\n \"BillingAddressCountry\": \"United Kingdom Updated\",\r\n \"PrimaryContactTelephoneMain\": \"Contact Telephone Main a\",\r\n \"AccountDetailsFax2\": \"Account Details Fax 2a\",\r\n \"PrimaryContactBillingEmail\": \"joebloggs@informbilling.co.uk\",\r\n \"AccountTypeIsCustomer\": true,\r\n \"AccountTypeIsDealer\": false,\r\n \"AccountTypeIsSupplier\": false,\r\n \"AccountTypeIsProspect\": false,\r\n \"AccountTypeIsContact\": false,\r\n \"AccountOnStop\": false,\r\n \"CreditLimit\": 125000.0000,\r\n \"BillingAddressFao\": \"Billing Address Fao Updated\",\r\n \"VatRegistered\": false,\r\n \"VatNo\": \"Vat No Updated\",\r\n \"AccountCreatedDate\": \"2024-08-21T16:51:49.72Z\",\r\n \"InvoiceNo\": null,\r\n \"InvoiceDate\": null,\r\n \"AccountDetailsCompanyRegNo\": \"11223344a\",\r\n \"AccountDetailsCompanyType\": \"Account Details Company Type Updated\",\r\n \"AccountDetailsYearsTrading\": 2,\r\n \"PaymentMethod\": 5,\r\n \"AccountTypeReseller\": false,\r\n \"EmailInvoiceToAccount\": true,\r\n \"SalesManager\": {\r\n \"Id\": 3,\r\n \"Name\": \"Sales Manager Jane\"\r\n },\r\n \"AccountManager\": {\r\n \"Id\": 2,\r\n \"Name\": \"Acccount Manager Alice\"\r\n },\r\n \"CreditDays\": 21.0000,\r\n \"ZipFilesAttachedForEmailInvoice\": true,\r\n \"MergePDFFilesForEmailInvoice\": true,\r\n \"UserDefinedField\": {\r\n \"Custom1\": \"Custom 1 Client Gateway Updated\",\r\n \"Custom2\": null,\r\n \"Custom3\": \"Custom 3 Client Gateway Updated\",\r\n \"Custom4\": null,\r\n \"Custom5\": \"Custom 5 Client Gateway Updated\",\r\n \"Custom6\": null,\r\n \"Custom7\": \"Standard Customer\",\r\n \"Custom8\": null,\r\n \"Custom9\": \"Male\",\r\n \"Custom10\": null,\r\n \"Custom11\": \"No\",\r\n \"Custom12\": null,\r\n \"Custom13\": null,\r\n \"Custom14\": null,\r\n \"Custom15\": null\r\n },\r\n \"ItemiseCallsWithSecondsGreaterThan\": 5,\r\n \"ItemiseCallsWithCostGreaterThan\": 0.4560,\r\n \"PrintAnalysis\": true,\r\n \"EmailAnalysisToAccount\": true,\r\n \"AnalysisStyleId\": 1,\r\n \"AdditionalInvoiceText\": null,\r\n \"IsPrinted\": false,\r\n \"ShowIntroducerOnInvoice\": false,\r\n \"MinimumBillValue\": 999.9900,\r\n \"BillStyle\": \"SME Style\",\r\n \"VatCode\": {\r\n \"Id\": 1,\r\n \"Code\": \"T0\",\r\n \"Rate\": 0.0000\r\n },\r\n \"BillingCompany\": {\r\n \"Id\": 5,\r\n \"Name\": \"Template Company 02\"\r\n },\r\n \"AnticipatedSpend\": 99800.5500,\r\n \"PoNumber\": \"Po Number\",\r\n \"AccountReference\": \"Account Reference\",\r\n \"PriceList\": {\r\n \"Id\": 1,\r\n \"Name\": \"Price List 1\"\r\n },\r\n \"AdvancedMonths\": 0,\r\n \"ClosedDate\": null,\r\n \"AlertsEmail\": \"samanthadoe@informbilling.co.uk\",\r\n \"LastUpdated\": \"2024-09-02T11:23:25.3518919+01:00\"\r\n },\r\n \"JobNumber\": null,\r\n \"MayRequireRerate\": false\r\n}"}],"_postman_id":"fd1444f7-45d8-4787-b8f7-43c2d2dc0539"}],"id":"d13de11a-621d-4ee0-97c5-732f690b73ba","_postman_id":"d13de11a-621d-4ee0-97c5-732f690b73ba","description":""}],"id":"c6bfd47b-c19f-4f59-bad7-4f30aec87852","description":"Contains endpoints relating to the account and account profile.
\n","_postman_id":"c6bfd47b-c19f-4f59-bad7-4f30aec87852"},{"name":"Account Profile","item":[{"name":"v1","item":[{"name":"Get Account Profile","id":"f6667fca-b147-4eb3-a61b-b0b26a38bdb8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access-token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":""},"url":"{{mainUrl}}v1/AccountProfile/GetAccountProfiles","description":"Gets account profiles.
\n","urlObject":{"path":["AccountProfile","GetAccountProfiles"],"host":["{{mainUrl}}v1"],"query":[],"variable":[]}},"response":[{"id":"9af0bc18-4844-4912-b5f8-110d16288a7e","name":"Get Account Profile","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{mainUrl}}v1/AccountProfile/GetAccountProfiles"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\r\n \"ReturnModel\": [\r\n {\r\n \"Id\": 2,\r\n \"Name\": \"Sample Profile\"\r\n },\r\n {\r\n \"Id\": 4,\r\n \"Name\": \"SOHO Style\"\r\n },\r\n {\r\n \"Id\": 5,\r\n \"Name\": \"SME Style\"\r\n },\r\n {\r\n \"Id\": 6,\r\n \"Name\": \"FULL Style\"\r\n }\r\n ],\r\n \"JobNumber\": null,\r\n \"MayRequireRerate\": false\r\n}"}],"_postman_id":"f6667fca-b147-4eb3-a61b-b0b26a38bdb8"}],"id":"ac18d4d3-14df-441b-98c9-e96a0a695cf6","_postman_id":"ac18d4d3-14df-441b-98c9-e96a0a695cf6","description":""}],"id":"730f9a0d-a261-44e4-b72d-92beb07914ca","description":"Contains endpoints relating to the account profile.
\n","_postman_id":"730f9a0d-a261-44e4-b72d-92beb07914ca"},{"name":"Contact","item":[{"name":"v1","item":[{"name":"Search Contact Paged","id":"1f2f3b2c-08e2-46c1-8613-61070e81b1cd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access-token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"{ \n \"GroupedFilterExpressions\":[\n {\n \"FilterExpressions\": [\n { \n \"FieldName\": \"AccountId\",\n \"FieldValue\": 2,\n \"FilterFunction\": \"EqualTo\"\n }\n ]\n }\n ],\n \"SortExpressions\": [\n {\n \"FieldName\": \"Id\",\n \"SortOrder\": \"Ascending\"\n }\n ],\n \"PageNumber\": 1,\n \"PageSize\": 100\n}"},"url":"{{mainUrl}}v1/Contact/SearchContactPaged","description":"Searches contact data with pagination and sorting.
\n","urlObject":{"path":["Contact","SearchContactPaged"],"host":["{{mainUrl}}v1"],"query":[],"variable":[]}},"response":[{"id":"b35ffb8d-78fa-42c4-8fab-7670c29c5cae","name":"Search Contact Paged","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"{ \n \"GroupedFilterExpressions\":[\n {\n \"FilterExpressions\": [\n { \n \"FieldName\": \"AccountId\",\n \"FieldValue\": 2,\n \"FilterFunction\": \"EqualTo\"\n }\n ]\n }\n ],\n \"SortExpressions\": [\n {\n \"FieldName\": \"Id\",\n \"SortOrder\": \"Ascending\"\n }\n ],\n \"PageNumber\": 1,\n \"PageSize\": 100\n}","options":{"raw":{"language":"json"}}},"url":"{{mainUrl}}v1/Contact/SearchContactPaged"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnModel\": {\n \"CurrentPage\": 1,\n \"TotalPages\": 1,\n \"TotalItems\": 1,\n \"ItemsPerPage\": 100,\n \"Items\": [\n {\n \"Id\": 3,\n \"AccountId\": 2,\n \"Surname\": \"Bloggs\",\n \"Forename\": \"Joe\",\n \"Title\": \"Manager\",\n \"Salutation\": \"Mr\",\n \"TelephoneAlt\": \"0123456789\",\n \"TelephoneMain\": \"1234567890\",\n \"TelephoneMobile\": \"4567890123\",\n \"Extension\": \"002\",\n \"Fax\": \"7890123456\",\n \"Email\": \"email@infrombilling.co.uk\",\n \"Address\": \"Address\",\n \"Postcode\": \"Postcode\"\n }\n ]\n },\n \"JobNumber\": null,\n \"MayRequireRerate\": false\n}"}],"_postman_id":"1f2f3b2c-08e2-46c1-8613-61070e81b1cd"}],"id":"e36d5e32-77b4-4653-a542-911f374f5d60","_postman_id":"e36d5e32-77b4-4653-a542-911f374f5d60","description":""}],"id":"40d6c808-9ff2-43e7-8a95-488b090f4c26","description":"Contains endpoints relating to the contact.
\n","_postman_id":"40d6c808-9ff2-43e7-8a95-488b090f4c26"},{"name":"Lookup","item":[{"name":"v1","item":[{"name":"Get Payment Methods","id":"01975ed9-4349-4fd4-a8b6-d5fa6c5f6f73","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access-token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":""},"url":"{{mainUrl}}v1/PaymentMethod/GetPaymentMethods","description":"Gets the supported payment methods.
\n","urlObject":{"path":["PaymentMethod","GetPaymentMethods"],"host":["{{mainUrl}}v1"],"query":[],"variable":[]}},"response":[{"id":"500f25e2-15e7-4c9f-b2d3-beb86638efa5","name":"Get Payment Methods","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{mainUrl}}v1/PaymentMethod/GetPaymentMethods"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\r\n \"ReturnModel\": [\r\n {\r\n \"Id\": 1,\r\n \"Name\": \"Cheque\"\r\n },\r\n {\r\n \"Id\": 2,\r\n \"Name\": \"Direct Debit\"\r\n },\r\n {\r\n \"Id\": 3,\r\n \"Name\": \"Standing Order\"\r\n },\r\n {\r\n \"Id\": 4,\r\n \"Name\": \"Credit Card\"\r\n },\r\n {\r\n \"Id\": 5,\r\n \"Name\": \"Other\"\r\n },\r\n {\r\n \"Id\": 6,\r\n \"Name\": \"Fixed Direct Debit\"\r\n },\r\n {\r\n \"Id\": 7,\r\n \"Name\": \"BACS Transfer\"\r\n }\r\n ],\r\n \"JobNumber\": null,\r\n \"MayRequireRerate\": false\r\n}"}],"_postman_id":"01975ed9-4349-4fd4-a8b6-d5fa6c5f6f73"},{"name":"Get VAT Codes","id":"776abdeb-389d-4a74-8d4b-069a2d147834","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":""},"url":"{{mainUrl}}v1/Lookup/GetVATCodes","urlObject":{"path":["Lookup","GetVATCodes"],"host":["{{mainUrl}}v1"],"query":[],"variable":[]}},"response":[{"id":"86443003-dada-478d-aaac-b828f25977ed","name":"Get VAT Codes","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"url":"{{mainUrl}}v1/Lookup/GetVATCodes"},"code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Id\": 1,\n \"Code\": \"T0\",\n \"Rate\": 0.0000,\n \"CodeDescription\": \"Zero-rated\",\n \"IsDefault\": false\n },\n {\n \"Id\": 2,\n \"Code\": \"T1\",\n \"Rate\": 20.0000,\n \"CodeDescription\": \"UK Standard VAT\",\n \"IsDefault\": true\n },\n {\n \"Id\": 13,\n \"Code\": \"T2\",\n \"Rate\": 5.0000,\n \"CodeDescription\": \"UK Reduced VAT\",\n \"IsDefault\": false\n },\n {\n \"Id\": 14,\n \"Code\": \"X20\",\n \"Rate\": 20.0000,\n \"CodeDescription\": \"20% (VAT on Income)\",\n \"IsDefault\": false\n },\n {\n \"Id\": 15,\n \"Code\": \"X0\",\n \"Rate\": 0.0000,\n \"CodeDescription\": \"No VAT\",\n \"IsDefault\": false\n }\n]"}],"_postman_id":"776abdeb-389d-4a74-8d4b-069a2d147834"}],"id":"e6e02659-7bf0-408e-8ecd-f871f813ee7e","_postman_id":"e6e02659-7bf0-408e-8ecd-f871f813ee7e","description":""}],"id":"3dbb7e49-3634-4023-a1a9-2d8ccb1e0b68","_postman_id":"3dbb7e49-3634-4023-a1a9-2d8ccb1e0b68","description":""}],"id":"9c6819ed-d352-46e6-a6b8-cc19287fff95","description":"Contains endpoints relating to the account.
\n","_postman_id":"9c6819ed-d352-46e6-a6b8-cc19287fff95"},{"name":"Bill Plan","item":[{"name":"v1","item":[{"name":"Search Bill Plan Paged","id":"cfc4f7cb-8e0c-4c93-b0c9-5fa03716b757","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access-token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"{ \n \"GroupedFilterExpressions\": [\n {\n \"FilterExpressions\": [\n {\n \"FieldName\": \"Account.AccountNumber\",\n \"FieldValue\": \"0000000A\",\n \"FilterFunction\": \"EqualTo\"\n }\n ],\n \"FilterExpressionsUsingOR\": false\n }\n ], \n \"SortExpressions\": [\n {\n \"FieldName\": \"LastUpdated\",\n \"SortOrder\": \"Descending\"\n }\n ],\n \"PageNumber\": 1,\n \"PageSize\": 100\n}"},"url":"{{mainUrl}}v1/BillPlan/SearchBillPlansPaged","description":"Searches bill plan data with pagination and sorting.
\n","urlObject":{"path":["BillPlan","SearchBillPlansPaged"],"host":["{{mainUrl}}v1"],"query":[],"variable":[]}},"response":[{"id":"76ce9e29-8008-4e1b-8841-061f7fa1b897","name":"Search Bill Plan Paged","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"{ \n \"GroupedFilterExpressions\": [\n {\n \"FilterExpressions\": [\n {\n \"FieldName\": \"Account.AccountNumber\",\n \"FieldValue\": \"0000000A\",\n \"FilterFunction\": \"EqualTo\"\n }\n ],\n \"FilterExpressionsUsingOR\": false\n }\n ], \n \"SortExpressions\": [\n {\n \"FieldName\": \"LastUpdated\",\n \"SortOrder\": \"Descending\"\n }\n ],\n \"PageNumber\": 1,\n \"PageSize\": 100\n}","options":{"raw":{"language":"json"}}},"url":"{{mainUrl}}v1/BillPlan/SearchBillPlansPaged"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnModel\": {\n \"CurrentPage\": 1,\n \"TotalPages\": 1,\n \"TotalItems\": 1,\n \"ItemsPerPage\": 100,\n \"Items\": [\n {\n \"Id\": 1956,\n \"Account\": {\n \"Id\": 2,\n \"AccountNumber\": \"0000000A\",\n \"AccountName\": \"Account Number\"\n },\n \"Name\": \"Billing Plan Name\",\n \"SiteContact\": \"Site Contact\",\n \"SiteAddress\": \"Site Address\",\n \"SystemManufacturer\": \"System Manufacturer\",\n \"SystemModel\": \"System Model\",\n \"SystemYearOfInstallation\": 1,\n \"SystemSoftwareVersion\": \"System Software Version\",\n \"SystemProgrammable\": true,\n \"SystemNumberOfExtensions\": 1,\n \"SystemContractRenewalDate\": \"2022-07-26T12:46:52.317Z\",\n \"SystemMaintainer\": {\n \"Id\": 4,\n \"Surname\": \"Joe\",\n \"Forename\": \"Bloggs\",\n \"Title\": \"Developer\",\n \"Salutation\": \"Mr\",\n \"TelephoneAlt\": \"123456789\",\n \"TelephoneMain\": \"234567890\",\n \"TelephoneMobile\": \"345678901\",\n \"Extension\": \"002\",\n \"Fax\": \"456789012\",\n \"Email\": \"joebloggs@informbilling.co.uk\",\n \"Address\": \"Address\",\n \"Postcode\": \"Postcode\"\n },\n \"SystemMaintenanceCost\": 1.600000023841858,\n \"SystemNumberOfLines\": 1,\n \"MaintainerOffersLcr\": true,\n \"PabxNotes\": \"Pabx Notes\",\n \"Email\": \"joebloggs@informbilling.co.uk\",\n \"PrintSummary\": true,\n \"EmailSummaryToAccount\": false,\n \"EmailSummaryToBillPlan\": false,\n \"ShowSavingOnSummary\": true,\n \"ExtensionLevelBilling\": true,\n \"AdditionalSummaryText\": \"sdfe\",\n \"PrintAnalysis\": true,\n \"EmailAnalysisToAccount\": false,\n \"EmailAnalysisToBillPlan\": false,\n \"AnalysisStyleId\": 1,\n \"UserDefinedField\": {\n \"Custom1\": \"Custom 1\",\n \"Custom2\": \"Custom 2\",\n \"Custom3\": \"Custom 3\",\n \"Custom4\": \"Custom 4\",\n \"Custom5\": \"Custom 5\",\n \"Custom6\": \"Custom 6\",\n \"Custom7\": \"Custom 7\",\n \"Custom8\": \"Custom 8\",\n \"Custom9\": \"Custom 9\",\n \"Custom10\": \"Custom 10\",\n \"Custom11\": \"Custom 11\",\n \"Custom12\": \"Custom 12\",\n \"Custom13\": \"Custom 13\",\n \"Custom14\": \"Custom 14\",\n \"Custom15\": \"Custom 15\"\n },\n \"DefaultNewCLIPrintSummary\": true,\n \"DefaultNewCLIPrintAnalysis\": true,\n \"DefaultNewCLIPrintItemisation\": true,\n \"DefaultNewCLIEmailSummaryToAccount\": true,\n \"DefaultNewCLIEmailAnalysisToAccount\": true,\n \"DefaultNewCLIEmailItemisationToAccount\": true,\n \"DefaultNewCLIEmailSummaryToBillPlan\": true,\n \"DefaultNewCLIEmailAnalysisToBillPlan\": true,\n \"DefaultNewCLIEmailItemisationToBillPlan\": true,\n \"DefaultNewCLIEmailSummaryToCLI\": true,\n \"DefaultNewCLIEmailAnalysisToCLI\": true,\n \"DefaultNewCLIEmailItemisationToCLI\": true,\n \"DefaultNewCliAnalysisStyleId\": 1,\n \"DefaultNewCLIShowSavingOnSummary\": true,\n \"DefaultNewCLIEmailCDRsToAccount\": true,\n \"DefaultNewCLIEmailCDRsToBillPlan\": true,\n \"DefaultNewCLIEmailCDRsToCLI\": true,\n \"IsClosed\": false,\n \"ClosedDate\": null,\n \"LastUpdated\": \"2022-09-21T10:23:06.3155871+01:00\"\n }\n ]\n },\n \"JobNumber\": null,\n \"MayRequireRerate\": false\n}"}],"_postman_id":"cfc4f7cb-8e0c-4c93-b0c9-5fa03716b757"},{"name":"Insert Bill Plan","id":"153fdb63-6535-44a1-8cb7-f035f23f1c52","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access-token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"{\n \"AccountId\": 54,\n \"Name\": \"Client Gateway Bill Plan 001\",\n \"SiteContact\": \"Site Contact\",\n \"SiteAddress\": \"Site Address\",\n \"SystemManufacturer\": \"System Manufacturer\",\n \"SystemModel\": \"System Model\",\n \"SystemYearOfInstallation\": 3,\n \"SystemSoftwareVersion\": \"System Software Version\",\n \"SystemProgrammable\": true,\n \"SystemNumberOfExtensions\": 4,\n \"SystemContractRenewalDate\": \"2025-01-01\",\n \"SystemMaintainerId\": 2,\n \"SystemMaintenanceCost\": 202.99,\n \"SystemNumberOfLines\": 6,\n \"MaintainerOffersLcr\": true,\n \"PabxNotes\": \"Pabx Notes\",\n \"Email\": \"joebloggs@infrombilling.co.uk\",\n \"PrintSummary\": true,\n \"EmailSummaryToAccount\": true,\n \"EmailSummaryToBillPlan\": true,\n \"ShowSavingOnSummary\": true,\n \"ExtensionLevelBilling\": true,\n \"AdditionalSummaryText\": \"Additional Summary Text\",\n \"PrintAnalysis\": true,\n \"EmailAnalysisToAccount\": true,\n \"EmailAnalysisToBillPlan\": true,\n \"AnalysisStyleId\": 2,\n \"UserDefinedField\": {\n \"Custom2\": \"Custom2\",\n \"Custom3\": \"Custom3\",\n \"Custom6\": \"Custom6\",\n \"Custom7\": \"Value A\",\n \"Custom9\": \"Custom9\",\n \"Custom11\": \"No\"\n },\n \"DefaultNewCLIPrintSummary\": true,\n \"DefaultNewCLIPrintAnalysis\": true,\n \"DefaultNewCLIPrintItemisation\": true,\n \"DefaultNewCLIEmailSummaryToAccount\": true,\n \"DefaultNewCLIEmailAnalysisToAccount\": true,\n \"DefaultNewCLIEmailItemisationToAccount\": true,\n \"DefaultNewCLIEmailSummaryToBillPlan\": true,\n \"DefaultNewCLIEmailAnalysisToBillPlan\": true,\n \"DefaultNewCLIEmailItemisationToBillPlan\": true,\n \"DefaultNewCLIEmailSummaryToCLI\": true,\n \"DefaultNewCLIEmailAnalysisToCLI\": true,\n \"DefaultNewCLIEmailItemisationToCLI\": true,\n \"DefaultNewCliAnalysisStyleId\": 3,\n \"DefaultNewCLIShowSavingOnSummary\": true,\n \"DefaultNewCLIEmailCDRsToAccount\": true,\n \"DefaultNewCLIEmailCDRsToBillPlan\": true,\n \"DefaultNewCLIEmailCDRsToCLI\": true\n}"},"url":"{{mainUrl}}v1/BillPlan/InsertBillPlan","description":"Inserts bill plan.
\nBelow is a list of mandatory fields:
\n","urlObject":{"path":["BillPlan","InsertBillPlan"],"host":["{{mainUrl}}v1"],"query":[],"variable":[]}},"response":[{"id":"87c2c768-3e6f-448a-bb34-ebdcfb9d8e4c","name":"Insert Bill Plan","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"{\n \"AccountId\": 54,\n \"Name\": \"Client Gateway Bill Plan 001\",\n \"SiteContact\": \"Site Contact\",\n \"SiteAddress\": \"Site Address\",\n \"SystemManufacturer\": \"System Manufacturer\",\n \"SystemModel\": \"System Model\",\n \"SystemYearOfInstallation\": 3,\n \"SystemSoftwareVersion\": \"System Software Version\",\n \"SystemProgrammable\": true,\n \"SystemNumberOfExtensions\": 4,\n \"SystemContractRenewalDate\": \"2025-01-01\",\n \"SystemMaintainerId\": 2,\n \"SystemMaintenanceCost\": 202.99,\n \"SystemNumberOfLines\": 6,\n \"MaintainerOffersLcr\": true,\n \"PabxNotes\": \"Pabx Notes\",\n \"Email\": \"joebloggs@infrombilling.co.uk\",\n \"PrintSummary\": true,\n \"EmailSummaryToAccount\": true,\n \"EmailSummaryToBillPlan\": true,\n \"ShowSavingOnSummary\": true,\n \"ExtensionLevelBilling\": true,\n \"AdditionalSummaryText\": \"Additional Summary Text\",\n \"PrintAnalysis\": true,\n \"EmailAnalysisToAccount\": true,\n \"EmailAnalysisToBillPlan\": true,\n \"AnalysisStyleId\": 2,\n \"UserDefinedField\": {\n \"Custom2\": \"Custom2\",\n \"Custom3\": \"Custom3\",\n \"Custom6\": \"Custom6\",\n \"Custom7\": \"Value A\",\n \"Custom9\": \"Custom9\",\n \"Custom11\": \"No\"\n },\n \"DefaultNewCLIPrintSummary\": true,\n \"DefaultNewCLIPrintAnalysis\": true,\n \"DefaultNewCLIPrintItemisation\": true,\n \"DefaultNewCLIEmailSummaryToAccount\": true,\n \"DefaultNewCLIEmailAnalysisToAccount\": true,\n \"DefaultNewCLIEmailItemisationToAccount\": true,\n \"DefaultNewCLIEmailSummaryToBillPlan\": true,\n \"DefaultNewCLIEmailAnalysisToBillPlan\": true,\n \"DefaultNewCLIEmailItemisationToBillPlan\": true,\n \"DefaultNewCLIEmailSummaryToCLI\": true,\n \"DefaultNewCLIEmailAnalysisToCLI\": true,\n \"DefaultNewCLIEmailItemisationToCLI\": true,\n \"DefaultNewCliAnalysisStyleId\": 3,\n \"DefaultNewCLIShowSavingOnSummary\": true,\n \"DefaultNewCLIEmailCDRsToAccount\": true,\n \"DefaultNewCLIEmailCDRsToBillPlan\": true,\n \"DefaultNewCLIEmailCDRsToCLI\": true\n}","options":{"raw":{"language":"json"}}},"url":"{{mainUrl}}v1/BillPlan/InsertBillPlan"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnModel\": {\n \"Id\": 3013,\n \"Account\": {\n \"Id\": 54,\n \"AccountNumber\": \"ACCNO001\",\n \"AccountName\": \"Account Name\"\n },\n \"Name\": \"Client Gateway Bill Plan 001\",\n \"SiteContact\": \"Site Contact\",\n \"SiteAddress\": \"Site Address\",\n \"SystemManufacturer\": \"System Manufacturer\",\n \"SystemModel\": \"System Model\",\n \"SystemYearOfInstallation\": 3,\n \"SystemSoftwareVersion\": \"System Software Version\",\n \"SystemProgrammable\": true,\n \"SystemNumberOfExtensions\": 4,\n \"SystemContractRenewalDate\": \"2025-01-01T00:00:00Z\",\n \"SystemMaintainer\": {\n \"Id\": 2,\n \"Surname\": \"Joe\",\n \"Forename\": \"Bloggs\",\n \"Title\": \"Developer\",\n \"Salutation\": \"Mr\",\n \"TelephoneAlt\": \"3453452423\",\n \"TelephoneMain\": \"1212122112\",\n \"TelephoneMobile\": \"345345345345\",\n \"Extension\": \"34545\",\n \"Fax\": \"567678768978\",\n \"Email\": \"JoeBloggs@informbilling.com\",\n \"Address\": \"Address\",\n \"Postcode\": \"Postcode\"\n },\n \"SystemMaintenanceCost\": 202.99,\n \"SystemNumberOfLines\": 6,\n \"MaintainerOffersLcr\": true,\n \"PabxNotes\": \"Pabx Notes\",\n \"Email\": \"joebloggs@infrombilling.co.uk\",\n \"PrintSummary\": true,\n \"EmailSummaryToAccount\": true,\n \"EmailSummaryToBillPlan\": true,\n \"ShowSavingOnSummary\": true,\n \"ExtensionLevelBilling\": true,\n \"AdditionalSummaryText\": \"Additional Summary Text\",\n \"PrintAnalysis\": true,\n \"EmailAnalysisToAccount\": true,\n \"EmailAnalysisToBillPlan\": true,\n \"AnalysisStyleId\": 2,\n \"UserDefinedField\": {\n \"Custom1\": null,\n \"Custom2\": \"Custom2\",\n \"Custom3\": \"Custom3\",\n \"Custom4\": null,\n \"Custom5\": null,\n \"Custom6\": \"Custom6\",\n \"Custom7\": \"Value A\",\n \"Custom8\": null,\n \"Custom9\": \"Custom9\",\n \"Custom10\": null,\n \"Custom11\": \"No\",\n \"Custom12\": null,\n \"Custom13\": null,\n \"Custom14\": null,\n \"Custom15\": null\n },\n \"DefaultNewCLIPrintSummary\": true,\n \"DefaultNewCLIPrintAnalysis\": true,\n \"DefaultNewCLIPrintItemisation\": true,\n \"DefaultNewCLIEmailSummaryToAccount\": true,\n \"DefaultNewCLIEmailAnalysisToAccount\": true,\n \"DefaultNewCLIEmailItemisationToAccount\": true,\n \"DefaultNewCLIEmailSummaryToBillPlan\": true,\n \"DefaultNewCLIEmailAnalysisToBillPlan\": true,\n \"DefaultNewCLIEmailItemisationToBillPlan\": true,\n \"DefaultNewCLIEmailSummaryToCLI\": true,\n \"DefaultNewCLIEmailAnalysisToCLI\": true,\n \"DefaultNewCLIEmailItemisationToCLI\": true,\n \"DefaultNewCliAnalysisStyleId\": 3,\n \"DefaultNewCLIShowSavingOnSummary\": true,\n \"DefaultNewCLIEmailCDRsToAccount\": true,\n \"DefaultNewCLIEmailCDRsToBillPlan\": true,\n \"DefaultNewCLIEmailCDRsToCLI\": true,\n \"IsClosed\": false,\n \"ClosedDate\": null,\n \"LastUpdated\": \"2024-09-18T14:22:51+01:00\"\n },\n \"JobNumber\": null,\n \"MayRequireRerate\": false\n}"}],"_postman_id":"153fdb63-6535-44a1-8cb7-f035f23f1c52"},{"name":"Update Bill Plan Primary Detail","id":"fcbf0fc9-ced6-4edb-afa1-694b5ac72ab3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access-token}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"{\n \"Id\": 3022,\n \"Name\": \"API Insert Bill Plan Updated\"\n}"},"url":"{{mainUrl}}v1/BillPlan/UpdateBillPlanPrimaryDetail","description":"Update bill plan record for the primary detail fields by id.
\nBelow is a list of mandatory fields. *Note that any non-mandatory fields not supplied in the model will be submitted with default values - as such any previously supplied values would be overwritten.
\n","urlObject":{"path":["BillPlan","UpdateBillPlanPrimaryDetail"],"host":["{{mainUrl}}v1"],"query":[],"variable":[]}},"response":[{"id":"9af3b04a-5a06-4dfb-8f94-10c8d27a9262","name":"Update Bill Plan Primary Detail","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"{\n \"Id\": 3022,\n \"Name\": \"API Insert Bill Plan Updated\"\n}","options":{"raw":{"language":"json"}}},"url":"{{mainUrl}}v1/BillPlan/UpdateBillPlanPrimaryDetail"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnModel\": {\n \"Id\": 3022,\n \"Account\": {\n \"Id\": 54,\n \"AccountNumber\": \"ACCNO001\",\n \"AccountName\": \"Account Name\"\n },\n \"Name\": \"API Insert Bill Plan Updated\",\n \"SiteContact\": \"Site Contact\",\n \"SiteAddress\": \"Site Address\",\n \"SystemManufacturer\": \"System Manufacturer\",\n \"SystemModel\": \"System Model\",\n \"SystemYearOfInstallation\": 3,\n \"SystemSoftwareVersion\": \"System Software Version\",\n \"SystemProgrammable\": true,\n \"SystemNumberOfExtensions\": 4,\n \"SystemContractRenewalDate\": \"2025-01-01T00:00:00Z\",\n \"SystemMaintainer\": {\n \"Id\": 2,\n \"Surname\": \"Maynard\",\n \"Forename\": \"Sharon\",\n \"Title\": \"-\",\n \"Salutation\": \"Mr\",\n \"TelephoneAlt\": \"3453452423\",\n \"TelephoneMain\": \"1212122112\",\n \"TelephoneMobile\": \"345345345345\",\n \"Extension\": \"34545\",\n \"Fax\": \"567678768978\",\n \"Email\": \"SharonLMaynard@informbilling.com\",\n \"Address\": \"3404 Rainbow Road\\nLondon\",\n \"Postcode\": \"SWA11A\"\n },\n \"SystemMaintenanceCost\": 202.99000549316406,\n \"SystemNumberOfLines\": 6,\n \"MaintainerOffersLcr\": true,\n \"PabxNotes\": \"Pabx Notes\",\n \"Email\": \"joebloggs@infrombilling.co.uk\",\n \"PrintSummary\": true,\n \"EmailSummaryToAccount\": true,\n \"EmailSummaryToBillPlan\": true,\n \"ShowSavingOnSummary\": true,\n \"ExtensionLevelBilling\": true,\n \"AdditionalSummaryText\": \"Additional Summary Text\",\n \"PrintAnalysis\": true,\n \"EmailAnalysisToAccount\": true,\n \"EmailAnalysisToBillPlan\": true,\n \"AnalysisStyleId\": 7,\n \"UserDefinedField\": {\n \"Custom1\": \"Custom 1 Is Mandatory - TextBox\",\n \"Custom2\": \"Custom 2 Is Not Mandatory - TextBox\",\n \"Custom3\": null,\n \"Custom4\": null,\n \"Custom5\": null,\n \"Custom6\": null,\n \"Custom7\": \"Value B\",\n \"Custom8\": null,\n \"Custom9\": null,\n \"Custom10\": null,\n \"Custom11\": null,\n \"Custom12\": null,\n \"Custom13\": null,\n \"Custom14\": null,\n \"Custom15\": null\n },\n \"DefaultNewCLIPrintSummary\": true,\n \"DefaultNewCLIPrintAnalysis\": true,\n \"DefaultNewCLIPrintItemisation\": true,\n \"DefaultNewCLIEmailSummaryToAccount\": true,\n \"DefaultNewCLIEmailAnalysisToAccount\": true,\n \"DefaultNewCLIEmailItemisationToAccount\": true,\n \"DefaultNewCLIEmailSummaryToBillPlan\": true,\n \"DefaultNewCLIEmailAnalysisToBillPlan\": true,\n \"DefaultNewCLIEmailItemisationToBillPlan\": true,\n \"DefaultNewCLIEmailSummaryToCLI\": true,\n \"DefaultNewCLIEmailAnalysisToCLI\": true,\n \"DefaultNewCLIEmailItemisationToCLI\": true,\n \"DefaultNewCliAnalysisStyleId\": 8,\n \"DefaultNewCLIShowSavingOnSummary\": true,\n \"DefaultNewCLIEmailCDRsToAccount\": true,\n \"DefaultNewCLIEmailCDRsToBillPlan\": true,\n \"DefaultNewCLIEmailCDRsToCLI\": true,\n \"IsClosed\": true,\n \"ClosedDate\": \"2024-09-18T00:00:00Z\",\n \"LastUpdated\": \"2024-09-20T17:28:47.0223985+01:00\"\n },\n \"JobNumber\": null,\n \"MayRequireRerate\": false\n}"}],"_postman_id":"fcbf0fc9-ced6-4edb-afa1-694b5ac72ab3"},{"name":"Update Bill Plan Site PABX","id":"b6af794e-8e31-44f2-b738-0b0da4e20286","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access-token}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"{\n \"Id\": 3022,\n \"SiteContact\": \"Site Contact\",\n \"SiteAddress\": \"Site Address\",\n \"SystemManufacturer\": \"System Manufacturer\",\n \"SystemModel\": \"System Model\",\n \"SystemYearOfInstallation\": 5,\n \"SystemProgrammable\": true,\n \"SystemSoftwareVersion\": \"System Software Version\",\n \"SystemNumberOfExtensions\": 555,\n \"SystemNumberOfLines\": 17,\n \"MaintainerOffersLcr\": true,\n \"SystemMaintainerId\": 3,\n \"SystemMaintenanceCost\": 300,\n \"SystemContractRenewalDate\": \"2025-01-01 00:00:00\",\n \"PabxNotes\": \"Pabx Notes\"\n}"},"url":"{{mainUrl}}v1/BillPlan/UpdateBillPlanSitePABX","description":"Update bill plan record for the site & PABX fields by id.
\nBelow is a list of mandatory fields. *Note that any non-mandatory fields not supplied in the model will be submitted with default values - as such any previously supplied values would be overwritten.
\n","urlObject":{"path":["BillPlan","UpdateBillPlanSitePABX"],"host":["{{mainUrl}}v1"],"query":[],"variable":[]}},"response":[{"id":"8cbbbf0c-bf86-4b4f-bb14-86f71a46a717","name":"Update Bill Plan Site PABX","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"{\n \"Id\": 3022,\n \"SiteContact\": \"Site Contact\",\n \"SiteAddress\": \"Site Address\",\n \"SystemManufacturer\": \"System Manufacturer\",\n \"SystemModel\": \"System Model\",\n \"SystemYearOfInstallation\": 5,\n \"SystemProgrammable\": true,\n \"SystemSoftwareVersion\": \"System Software Version\",\n \"SystemNumberOfExtensions\": 555,\n \"SystemNumberOfLines\": 17,\n \"MaintainerOffersLcr\": true,\n \"SystemMaintainerId\": 3,\n \"SystemMaintenanceCost\": 300,\n \"SystemContractRenewalDate\": \"2025-01-01 00:00:00\",\n \"PabxNotes\": \"Pabx Notes\"\n}","options":{"raw":{"language":"json"}}},"url":"{{mainUrl}}v1/BillPlan/UpdateBillPlanSitePABX"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnModel\": {\n \"Id\": 3022,\n \"Account\": {\n \"Id\": 54,\n \"AccountNumber\": \"ACCNO001\",\n \"AccountName\": \"Account Name\"\n },\n \"Name\": \"API Insert Bill Plan Updated\",\n \"SiteContact\": \"Site Contact\",\n \"SiteAddress\": \"Site Address\",\n \"SystemManufacturer\": \"System Manufacturer\",\n \"SystemModel\": \"System Model\",\n \"SystemYearOfInstallation\": 5,\n \"SystemSoftwareVersion\": \"System Software Version\",\n \"SystemProgrammable\": true,\n \"SystemNumberOfExtensions\": 555,\n \"SystemContractRenewalDate\": \"2025-01-01T00:00:00Z\",\n \"SystemMaintainer\": null,\n \"SystemMaintenanceCost\": 300.0,\n \"SystemNumberOfLines\": 17,\n \"MaintainerOffersLcr\": true,\n \"PabxNotes\": \"Pabx Notes\",\n \"Email\": \"joebloggs@informbilling.co.uk\",\n \"PrintSummary\": false,\n \"EmailSummaryToAccount\": false,\n \"EmailSummaryToBillPlan\": false,\n \"ShowSavingOnSummary\": false,\n \"ExtensionLevelBilling\": false,\n \"AdditionalSummaryText\": \"Additional Summary Text\",\n \"PrintAnalysis\": false,\n \"EmailAnalysisToAccount\": false,\n \"EmailAnalysisToBillPlan\": false,\n \"AnalysisStyleId\": 3,\n \"UserDefinedField\": {\n \"Custom1\": \"Custom 1 Is Mandatory - TextBox\",\n \"Custom2\": \"Custom 2 Is Not Mandatory - TextBox\",\n \"Custom3\": null,\n \"Custom4\": null,\n \"Custom5\": null,\n \"Custom6\": null,\n \"Custom7\": \"Value B\",\n \"Custom8\": null,\n \"Custom9\": null,\n \"Custom10\": null,\n \"Custom11\": null,\n \"Custom12\": null,\n \"Custom13\": null,\n \"Custom14\": null,\n \"Custom15\": null\n },\n \"DefaultNewCLIPrintSummary\": false,\n \"DefaultNewCLIPrintAnalysis\": false,\n \"DefaultNewCLIPrintItemisation\": false,\n \"DefaultNewCLIEmailSummaryToAccount\": false,\n \"DefaultNewCLIEmailAnalysisToAccount\": false,\n \"DefaultNewCLIEmailItemisationToAccount\": false,\n \"DefaultNewCLIEmailSummaryToBillPlan\": false,\n \"DefaultNewCLIEmailAnalysisToBillPlan\": false,\n \"DefaultNewCLIEmailItemisationToBillPlan\": false,\n \"DefaultNewCLIEmailSummaryToCLI\": false,\n \"DefaultNewCLIEmailAnalysisToCLI\": false,\n \"DefaultNewCLIEmailItemisationToCLI\": false,\n \"DefaultNewCliAnalysisStyleId\": 4,\n \"DefaultNewCLIShowSavingOnSummary\": false,\n \"DefaultNewCLIEmailCDRsToAccount\": false,\n \"DefaultNewCLIEmailCDRsToBillPlan\": false,\n \"DefaultNewCLIEmailCDRsToCLI\": false,\n \"IsClosed\": true,\n \"ClosedDate\": \"2024-09-18T00:00:00Z\",\n \"LastUpdated\": \"2024-09-20T17:29:06.3930916+01:00\"\n },\n \"JobNumber\": null,\n \"MayRequireRerate\": false\n}"}],"_postman_id":"b6af794e-8e31-44f2-b738-0b0da4e20286"},{"name":"Update Bill Plan User Defined Field","id":"cf0ca159-2daf-4827-b6a1-9459ddb838e4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access-token}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"{\n \"BillPlanId\": 3022,\n \"Custom1\": \"Custom 1 Is Mandatory - TextBox\",\n \"Custom2\": \"Custom 2 Is Not Mandatory - TextBox\",\n \"Custom3\": null,\n \"Custom4\": \"DataListValue\",\n \"Custom5\": \"Custom 5 Is Not Mandatory - ComboBox\"\n}"},"url":"{{mainUrl}}v1/BillPlan/UpdateBillPlanUserDefinedField","description":"Update bill plan record for the user defined fields/custom fields by id based on setup.
\n","urlObject":{"path":["BillPlan","UpdateBillPlanUserDefinedField"],"host":["{{mainUrl}}v1"],"query":[],"variable":[]}},"response":[{"id":"7e5d272c-d9fb-41e0-9b1f-f4867a71249d","name":"Update Bill Plan User Defined Field","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"{\n \"BillPlanId\": 3022,\n \"Custom1\": \"Custom 1 Updated\",\n \"Custom2\": \"Custom 2 Updated\",\n \"Custom7\": \"Value B\"\n}","options":{"raw":{"language":"json"}}},"url":"{{mainUrl}}v1/BillPlan/UpdateBillPlanUserDefinedField"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnModel\": {\n \"Id\": 3022,\n \"Account\": {\n \"Id\": 54,\n \"AccountNumber\": \"ACCNO001\",\n \"AccountName\": \"Account Name\"\n },\n \"Name\": \"API Insert Bill Plan Updated\",\n \"SiteContact\": \"Site Contact\",\n \"SiteAddress\": \"Site Address\",\n \"SystemManufacturer\": \"System Manufacturer\",\n \"SystemModel\": \"System Model\",\n \"SystemYearOfInstallation\": 5,\n \"SystemSoftwareVersion\": \"System Software Version\",\n \"SystemProgrammable\": true,\n \"SystemNumberOfExtensions\": 555,\n \"SystemContractRenewalDate\": \"2025-01-01T00:00:00Z\",\n \"SystemMaintainer\": null,\n \"SystemMaintenanceCost\": 300.0,\n \"SystemNumberOfLines\": 17,\n \"MaintainerOffersLcr\": true,\n \"PabxNotes\": \"Pabx Notes\",\n \"Email\": \"joebloggs@informbilling.co.uk\",\n \"PrintSummary\": false,\n \"EmailSummaryToAccount\": false,\n \"EmailSummaryToBillPlan\": false,\n \"ShowSavingOnSummary\": false,\n \"ExtensionLevelBilling\": false,\n \"AdditionalSummaryText\": \"Additional Summary Text\",\n \"PrintAnalysis\": false,\n \"EmailAnalysisToAccount\": false,\n \"EmailAnalysisToBillPlan\": false,\n \"AnalysisStyleId\": 3,\n \"UserDefinedField\": {\n \"Custom1\": \"Custom 1 Updated\",\n \"Custom2\": \"Custom 2 Updated\",\n \"Custom3\": null,\n \"Custom4\": null,\n \"Custom5\": null,\n \"Custom6\": null,\n \"Custom7\": \"Value B\",\n \"Custom8\": null,\n \"Custom9\": null,\n \"Custom10\": null,\n \"Custom11\": null,\n \"Custom12\": null,\n \"Custom13\": null,\n \"Custom14\": null,\n \"Custom15\": null\n },\n \"DefaultNewCLIPrintSummary\": false,\n \"DefaultNewCLIPrintAnalysis\": false,\n \"DefaultNewCLIPrintItemisation\": false,\n \"DefaultNewCLIEmailSummaryToAccount\": false,\n \"DefaultNewCLIEmailAnalysisToAccount\": false,\n \"DefaultNewCLIEmailItemisationToAccount\": false,\n \"DefaultNewCLIEmailSummaryToBillPlan\": false,\n \"DefaultNewCLIEmailAnalysisToBillPlan\": false,\n \"DefaultNewCLIEmailItemisationToBillPlan\": false,\n \"DefaultNewCLIEmailSummaryToCLI\": false,\n \"DefaultNewCLIEmailAnalysisToCLI\": false,\n \"DefaultNewCLIEmailItemisationToCLI\": false,\n \"DefaultNewCliAnalysisStyleId\": 4,\n \"DefaultNewCLIShowSavingOnSummary\": false,\n \"DefaultNewCLIEmailCDRsToAccount\": false,\n \"DefaultNewCLIEmailCDRsToBillPlan\": false,\n \"DefaultNewCLIEmailCDRsToCLI\": false,\n \"IsClosed\": true,\n \"ClosedDate\": \"2024-09-18T00:00:00Z\",\n \"LastUpdated\": \"2024-09-20T17:29:06.3930916+01:00\"\n },\n \"JobNumber\": null,\n \"MayRequireRerate\": false\n}"}],"_postman_id":"cf0ca159-2daf-4827-b6a1-9459ddb838e4"}],"id":"3e365095-0442-477d-8a40-93da0cbf34f8","_postman_id":"3e365095-0442-477d-8a40-93da0cbf34f8","description":""}],"id":"457d95b0-8074-453e-8bb1-2b9edade944c","description":"Contains endpoints relating to the bill plan.
\n","_postman_id":"457d95b0-8074-453e-8bb1-2b9edade944c"},{"name":"Billing","item":[{"name":"Invoice","item":[{"name":"v1","item":[{"name":"Search Recurring Invoice Header Paged","id":"d1f450d5-414f-420c-82d3-d045098cb4a5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access-token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"{ \n \"GroupedFilterExpressions\": [\n {\n \"FilterExpressions\": [\n { \n \"FieldName\":\"Id\",\n \"FieldValue\": 4053,\n \"FilterFunction\": \"EqualTo\"\n }\n ],\n \"FilterExpressionsUsingOR\": false\n }\n ],\n \"SortExpressions\": [\n {\n \"FieldName\": \"Id\",\n \"SortOrder\": \"Ascending\"\n }\n ],\n \"PageNumber\": 1,\n \"PageSize\": 50\n}"},"url":"{{mainUrl}}v1/Invoice/SearchRecurringInvoiceHeaderPaged","description":"Searches recurring and active invoice header data with pagination and sorting.
\n","urlObject":{"path":["Invoice","SearchRecurringInvoiceHeaderPaged"],"host":["{{mainUrl}}v1"],"query":[],"variable":[]}},"response":[{"id":"05c6ae01-39d6-40e0-99bf-9a8b8bd3489b","name":"Search Recurring Invoice Header Paged","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"{ \n \"GroupedFilterExpressions\": [\n {\n \"FilterExpressions\": [\n { \n \"FieldName\":\"Id\",\n \"FieldValue\": 4053,\n \"FilterFunction\": \"EqualTo\"\n }\n ],\n \"FilterExpressionsUsingOR\": false\n }\n ],\n \"SortExpressions\": [\n {\n \"FieldName\": \"Id\",\n \"SortOrder\": \"Ascending\"\n }\n ],\n \"PageNumber\": 1,\n \"PageSize\": 50\n}","options":{"raw":{"language":"json"}}},"url":"{{mainUrl}}v1/Invoice/SearchRecurringInvoiceHeaderPaged"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\r\n \"ReturnModel\": {\r\n \"CurrentPage\": 1,\r\n \"TotalPages\": 1,\r\n \"TotalItems\": 1,\r\n \"ItemsPerPage\": 50,\r\n \"Items\": [\r\n {\r\n \"Id\": 4053,\r\n \"Company\": {\r\n \"Id\": 4,\r\n \"Name\": \"Template Company\"\r\n },\r\n \"Account\": {\r\n \"Id\": 54,\r\n \"AccountNumber\": \"5800-004\",\r\n \"AccountName\": \"NG-5800-004\"\r\n },\r\n \"Username\": \"Close Cycle\",\r\n \"PONumber\": \"PO9217364\",\r\n \"InvoiceNumber\": \"100012\",\r\n \"InvoiceDate\": \"2024-04-30T00:00:00Z\",\r\n \"Bfao\": \"Accounts Department\",\r\n \"BAddress\": \"10 downing street\\n\\nLondon\\n\\nUnited Kingdom\\n\",\r\n \"BPostcode\": \"SWA1AAA\",\r\n \"CreditDays\": 14,\r\n \"CustomerRef\": \"Customer ref\",\r\n \"AdditionalInvoiceText\": \"This is an additional invoice text\",\r\n \"Email\": \"joebloggs@informbilling.co.uk\",\r\n \"InvoiceTotal\": 51.4920000000,\r\n \"SubTotal\": 42.9100,\r\n \"VATTotal\": 8.5800,\r\n \"InvoiceStatus\": {\r\n \"Id\": 1,\r\n \"Description\": \"Finalised\"\r\n }\r\n }\r\n ]\r\n },\r\n \"JobNumber\": null,\r\n \"MayRequireRerate\": false\r\n}"}],"_postman_id":"d1f450d5-414f-420c-82d3-d045098cb4a5"},{"name":"Search Recurring Invoice Lines Paged","id":"d7dd148d-b2f6-41b6-b4aa-74240a0e92b6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access-token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"{ \n \"GroupedFilterExpressions\": [\n {\n \"FilterExpressions\": [\n { \n \"FieldName\":\"Product.ProductCode\",\n \"FieldValue\": \"BARR\",\n \"FilterFunction\": \"EndsWith\"\n }\n ],\n \"FilterExpressionsUsingOR\": false\n }\n ],\n \"SortExpressions\": [\n {\n \"FieldName\": \"InvoiceId\",\n \"SortOrder\": \"Ascending\"\n }\n ],\n \"PageNumber\": 1,\n \"PageSize\": 2\n}"},"url":"{{mainUrl}}v1/Invoice/SearchRecurringInvoiceLinesPaged","description":"Searches recurring and active invoice line data with pagination and sorting.
\n","urlObject":{"path":["Invoice","SearchRecurringInvoiceLinesPaged"],"host":["{{mainUrl}}v1"],"query":[],"variable":[]}},"response":[{"id":"636d34ff-5508-4f55-b01d-5dc06772baf7","name":"Search Recurring Invoice Lines Paged","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"{ \n \"GroupedFilterExpressions\": [\n {\n \"FilterExpressions\": [\n { \n \"FieldName\":\"Product.ProductCode\",\n \"FieldValue\": \"BARR\",\n \"FilterFunction\": \"EndsWith\"\n }\n ],\n \"FilterExpressionsUsingOR\": false\n }\n ],\n \"SortExpressions\": [\n {\n \"FieldName\": \"InvoiceId\",\n \"SortOrder\": \"Ascending\"\n }\n ],\n \"PageNumber\": 1,\n \"PageSize\": 2\n}","options":{"raw":{"language":"json"}}},"url":"{{mainUrl}}v1/Invoice/SearchRecurringInvoiceLinesPaged"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\r\n \"ReturnModel\": {\r\n \"CurrentPage\": 1,\r\n \"TotalPages\": 10,\r\n \"TotalItems\": 19,\r\n \"ItemsPerPage\": 2,\r\n \"Items\": [\r\n {\r\n \"Cli\": {\r\n \"TelId\": 3271,\r\n \"PhoneNumber\": \"SALES001\"\r\n },\r\n \"InvoiceId\": 25,\r\n \"Product\": {\r\n \"Id\": 32,\r\n \"ProductCode\": \"C_BARR\",\r\n \"BuyPrice\": 1.2000,\r\n \"UnitPrice\": 2.0000,\r\n \"IsLineRental\": false\r\n },\r\n \"Description\": \"Customer Controlled Call Barring\",\r\n \"Quantity\": 1,\r\n \"Price\": 15.4800,\r\n \"VAT\": 3.0960000000,\r\n \"BuyPrice\": 7.50,\r\n \"LineRef\": \"Line Ref\"\r\n },\r\n {\r\n \"Cli\": null,\r\n \"InvoiceId\": 30,\r\n \"Product\": {\r\n \"Id\": 32,\r\n \"ProductCode\": \"C_BARR\",\r\n \"BuyPrice\": 1.2000,\r\n \"UnitPrice\": 2.0000,\r\n \"IsLineRental\": false\r\n },\r\n \"Description\": \"Customer Controlled Call Barring\",\r\n \"Quantity\": 1,\r\n \"Price\": 14.9700,\r\n \"VAT\": 2.9940000000,\r\n \"BuyPrice\": 8.16,\r\n \"LineRef\": \"Line Ref\"\r\n }\r\n ]\r\n },\r\n \"JobNumber\": null,\r\n \"MayRequireRerate\": false\r\n}"}],"_postman_id":"d7dd148d-b2f6-41b6-b4aa-74240a0e92b6"},{"name":"Search Sales Invoice Header Paged","id":"559e5f33-7b96-47cd-a3e4-5729cc951ecd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access-token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"{ \n \"GroupedFilterExpressions\": [\n {\n \"FilterExpressions\": [\n { \n \"FieldName\":\"BPostcode\",\n \"FieldValue\": \"SA62\",\n \"FilterFunction\": \"Contains\"\n }\n ],\n \"FilterExpressionsUsingOR\": false\n }\n ],\n \"SortExpressions\": [\n {\n \"FieldName\": \"Id\",\n \"SortOrder\": \"Ascending\"\n }\n ],\n \"PageNumber\": 1,\n \"PageSize\": 50\n}"},"url":"{{mainUrl}}v1/Invoice/SearchSalesInvoiceHeaderPaged","description":"Searches sales invoice header data with pagination and sorting.
\n","urlObject":{"path":["Invoice","SearchSalesInvoiceHeaderPaged"],"host":["{{mainUrl}}v1"],"query":[],"variable":[]}},"response":[{"id":"9dce36e5-4567-4192-b8e8-8c5ca01c1c12","name":"Search Sales Invoice Header Paged","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"{ \n \"GroupedFilterExpressions\": [\n {\n \"FilterExpressions\": [\n { \n \"FieldName\":\"BPostcode\",\n \"FieldValue\": \"SA62\",\n \"FilterFunction\": \"Contains\"\n }\n ],\n \"FilterExpressionsUsingOR\": false\n }\n ],\n \"SortExpressions\": [\n {\n \"FieldName\": \"Id\",\n \"SortOrder\": \"Ascending\"\n }\n ],\n \"PageNumber\": 1,\n \"PageSize\": 50\n}","options":{"raw":{"language":"json"}}},"url":"{{mainUrl}}v1/Invoice/SearchSalesInvoiceHeaderPaged"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\r\n \"ReturnModel\": {\r\n \"CurrentPage\": 1,\r\n \"TotalPages\": 1,\r\n \"TotalItems\": 1,\r\n \"ItemsPerPage\": 50,\r\n \"Items\": [\r\n {\r\n \"Id\": 4061,\r\n \"Company\": {\r\n \"Id\": 4,\r\n \"Name\": \"Template Company\"\r\n },\r\n \"Account\": {\r\n \"Id\": 3859,\r\n \"AccountNumber\": \"CUS-6246\",\r\n \"AccountName\": \"CUS NG-6246 - Close Cycle Invoice\"\r\n },\r\n \"Username\": \"joeb\",\r\n \"PONumber\": \"BAS0012317\",\r\n \"InvoiceNumber\": \"\",\r\n \"InvoiceDate\": \"2024-04-25T00:00:00Z\",\r\n \"Bfao\": \"Accounts Department\",\r\n \"BAddress\": \"39 Harehills Lane\\nRudbaxton\\n\\nSA62 7JF\\nUnited Kingdom\",\r\n \"BPostcode\": \"SA62 7JF\",\r\n \"CreditDays\": 14,\r\n \"CustomerRef\": \"Customer Ref\",\r\n \"AdditionalInvoiceText\": \"This is an additional invoice text\",\r\n \"Email\": \"joebloggs@informbilling.co.uk\",\r\n \"InvoiceTotal\": 963.48,\r\n \"SubTotal\": 192.70,\r\n \"VATTotal\": 1156.18,\r\n \"InvoiceStatus\": {\r\n \"Id\": 2,\r\n \"Description\": \"Not finalised\"\r\n }\r\n }\r\n ]\r\n },\r\n \"JobNumber\": null,\r\n \"MayRequireRerate\": false\r\n}"}],"_postman_id":"559e5f33-7b96-47cd-a3e4-5729cc951ecd"},{"name":"Search Sales Invoice Lines Paged","id":"295b4c91-d5bc-458d-84d3-2173d7b53b51","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access-token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"{ \n \"GroupedFilterExpressions\": [\n {\n \"FilterExpressions\": [\n { \n \"FieldName\":\"BuyPrice\",\n \"FieldValue\": 0.99,\n \"FilterFunction\": \"LessThanOrEqualTo\"\n }\n ],\n \"FilterExpressionsUsingOR\": false\n }\n ],\n \"SortExpressions\": [\n {\n \"FieldName\": \"BuyPrice\",\n \"SortOrder\": \"Descending\"\n }\n ],\n \"PageNumber\": 1,\n \"PageSize\": 50\n}"},"url":"{{mainUrl}}v1/Invoice/SearchSalesInvoiceLinesPaged","description":"Searches sales invoice line data with pagination and sorting.
\n","urlObject":{"path":["Invoice","SearchSalesInvoiceLinesPaged"],"host":["{{mainUrl}}v1"],"query":[],"variable":[]}},"response":[{"id":"b98a8cad-050b-466a-a9f6-5ddbb9752137","name":"Search Sales Invoice Lines Paged","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"{ \n \"GroupedFilterExpressions\": [\n {\n \"FilterExpressions\": [\n { \n \"FieldName\":\"BuyPrice\",\n \"FieldValue\": 0.99,\n \"FilterFunction\": \"LessThanOrEqualTo\"\n }\n ],\n \"FilterExpressionsUsingOR\": false\n }\n ],\n \"SortExpressions\": [\n {\n \"FieldName\": \"BuyPrice\",\n \"SortOrder\": \"Descending\"\n }\n ],\n \"PageNumber\": 1,\n \"PageSize\": 50\n}","options":{"raw":{"language":"json"}}},"url":"{{mainUrl}}v1/Invoice/SearchSalesInvoiceLinesPaged"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\r\n \"ReturnModel\": {\r\n \"CurrentPage\": 1,\r\n \"TotalPages\": 1,\r\n \"TotalItems\": 3,\r\n \"ItemsPerPage\": 50,\r\n \"Items\": [\r\n {\r\n \"InvoiceId\": 4061,\r\n \"Product\": {\r\n \"Id\": 31,\r\n \"ProductCode\": \"COLP\",\r\n \"BuyPrice\": 0.5000,\r\n \"UnitPrice\": 1.5000,\r\n \"IsLineRental\": false\r\n },\r\n \"Description\": \"Connected Line Identity Presentation (COLP)\",\r\n \"Quantity\": 1,\r\n \"Price\": 0.5000,\r\n \"VAT\": 0.1000,\r\n \"BuyPrice\": 0.2400,\r\n \"LineRef\": \"Line Ref\"\r\n },\r\n {\r\n \"InvoiceId\": 4065,\r\n \"Product\": {\r\n \"Id\": 31,\r\n \"ProductCode\": \"COLP\",\r\n \"BuyPrice\": 0.5000,\r\n \"UnitPrice\": 1.5000,\r\n \"IsLineRental\": false\r\n },\r\n \"Description\": \"Connected Line Identity Presentation (COLP)\",\r\n \"Quantity\": 3,\r\n \"Price\": 0.5000,\r\n \"VAT\": 0.3000,\r\n \"BuyPrice\": 0.2500,\r\n \"LineRef\": \"Line Ref\"\r\n },\r\n {\r\n \"InvoiceId\": 4080,\r\n \"Product\": {\r\n \"Id\": 29,\r\n \"ProductCode\": \"CLIP\",\r\n \"BuyPrice\": 0.7000,\r\n \"UnitPrice\": 1.0000,\r\n \"IsLineRental\": false\r\n },\r\n \"Description\": \"Calling Line Identity Presentation (CLIP)\",\r\n \"Quantity\": 1,\r\n \"Price\": 1.0000,\r\n \"VAT\": 0.2000,\r\n \"BuyPrice\": 0.5000,\r\n \"LineRef\": null\r\n }\r\n ]\r\n },\r\n \"JobNumber\": null,\r\n \"MayRequireRerate\": false\r\n}"}],"_postman_id":"295b4c91-d5bc-458d-84d3-2173d7b53b51"}],"id":"16cee293-9b66-4d6e-8c1a-3795f5b5e60b","_postman_id":"16cee293-9b66-4d6e-8c1a-3795f5b5e60b","description":""}],"id":"2c3de04c-a62e-414e-a7e4-9b5c3d90a241","description":"Contains endpoints relating to the invoice.
\n","_postman_id":"2c3de04c-a62e-414e-a7e4-9b5c3d90a241"}],"id":"df91624a-60d0-4d80-9129-b520a43d9402","description":"Contains endpoints relating to the billing.
\n","_postman_id":"df91624a-60d0-4d80-9129-b520a43d9402"},{"name":"Charge","item":[{"name":"Charge","item":[{"name":"v1","item":[{"name":"Search Account Level Charge Paged","id":"4fc4148f-c92b-49ec-92c8-b9edc8901662","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access-token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"{ \r\n \"GroupedFilterExpressions\":[\r\n {\r\n \"FilterExpressions\": [\r\n { \r\n \"FieldName\": \"Account.AccountNumber\",\r\n \"FieldValue\": \"FAL00001\",\r\n \"FilterFunction\": \"EqualTo\"\r\n }\r\n ]\r\n }\r\n ],\r\n \"SortExpressions\": [\r\n {\r\n \"FieldName\": \"LastUpdated\",\r\n \"SortOrder\": \"Descending\"\r\n }\r\n ],\r\n \"PageNumber\": 1,\r\n \"PageSize\": 50\r\n}"},"url":"{{mainUrl}}v1/Charge/SearchAccountLevelChargesPaged","description":"Searches account level charge data with pagination and sorting.
\n","urlObject":{"path":["Charge","SearchAccountLevelChargesPaged"],"host":["{{mainUrl}}v1"],"query":[],"variable":[]}},"response":[{"id":"fa78be9a-012d-4e89-9ce9-fb74e26d8196","name":"Search Account Level Charge Paged","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"{ \r\n \"GroupedFilterExpressions\":[\r\n {\r\n \"FilterExpressions\": [\r\n { \r\n \"FieldName\": \"Account.AccountNumber\",\r\n \"FieldValue\": \"FAL00001\",\r\n \"FilterFunction\": \"EqualTo\"\r\n }\r\n ]\r\n }\r\n ],\r\n \"SortExpressions\": [\r\n {\r\n \"FieldName\": \"LastUpdated\",\r\n \"SortOrder\": \"Descending\"\r\n }\r\n ],\r\n \"PageNumber\": 1,\r\n \"PageSize\": 50\r\n}","options":{"raw":{"language":"json"}}},"url":"{{mainUrl}}v1/Charge/SearchAccountLevelChargesPaged"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\r\n \"ReturnModel\": {\r\n \"CurrentPage\": 1,\r\n \"TotalPages\": 10,\r\n \"TotalItems\": 10,\r\n \"ItemsPerPage\": 1,\r\n \"Items\": [\r\n {\r\n \"Id\": 19406,\r\n \"Account\": {\r\n \"Id\": 9,\r\n \"AccountNumber\": \"FAL00001\",\r\n \"AccountName\": \"Falcon Communications Ltd\"\r\n },\r\n \"Product\": {\r\n \"Id\": 42,\r\n \"ProductCode\": \"LAPTOP_SUPPORT\",\r\n \"Description\": \"Laptop Support\",\r\n \"BuyPrice\": 10.0000,\r\n \"UnitPrice\": 19.0000,\r\n \"IsLineRental\": false\r\n },\r\n \"Description\": \"Laptop Support\",\r\n \"Quantity\": 3,\r\n \"UnitPrice\": 19.0000,\r\n \"RepeatCode\": 1,\r\n \"StartDate\": \"2015-02-01T00:00:00Z\",\r\n \"EndDate\": \"2016-11-30T00:00:00Z\",\r\n \"LastBillledToDate\": \"2016-11-30T00:00:00Z\",\r\n \"ApplyWhenValue\": 0.0000,\r\n \"RefNo\": \"Ref No\",\r\n \"Creator\": \"joebloggs\",\r\n \"CreditOnDisconnection\": true,\r\n \"IsCharged\": false,\r\n \"BuyPrice\": 19.0000,\r\n \"DateChargeAdded\": null,\r\n \"LastUpdated\": \"2024-05-22T14:19:16.8637114+01:00\",\r\n \"ContractEndDate\": null,\r\n \"ContractStartDate\": \"2015-02-01T00:00:00Z\",\r\n \"ContractLength\": 12,\r\n \"UseChargeStartDate\": true,\r\n \"SupplierFilter\": \"Unreconciled\",\r\n \"Dealer\": {\r\n \"Id\": null,\r\n \"AccountNumber\": null,\r\n \"AccountName\": null\r\n }\r\n }\r\n ]\r\n },\r\n \"JobNumber\": null,\r\n \"MayRequireRerate\": false\r\n}"}],"_postman_id":"4fc4148f-c92b-49ec-92c8-b9edc8901662"},{"name":"Search Cli Level Charge Paged","id":"d71bfe6a-15c5-4a9f-aafb-fa86ceb99e8c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access-token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"{ \r\n \"GroupedFilterExpressions\":[\r\n {\r\n \"FilterExpressions\": [\r\n { \r\n \"FieldName\": \"Cli.TelId\",\r\n \"FieldValue\": 18389,\r\n \"FilterFunction\": \"EqualTo\"\r\n }\r\n ]\r\n }\r\n ],\r\n \"SortExpressions\": [\r\n {\r\n \"FieldName\": \"LastUpdated\",\r\n \"SortOrder\": \"Descending\"\r\n }\r\n ],\r\n \"PageNumber\": 1,\r\n \"PageSize\": 50\r\n}"},"url":"{{mainUrl}}v1/Charge/SearchCliLevelChargesPaged","description":"Searches cli level charge data with pagination and sorting.
\n","urlObject":{"path":["Charge","SearchCliLevelChargesPaged"],"host":["{{mainUrl}}v1"],"query":[],"variable":[]}},"response":[{"id":"c30d9664-f6a1-47f6-b2e0-1c33f8ffcaf0","name":"Search Cli Level Charge Paged","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"{ \r\n \"GroupedFilterExpressions\":[\r\n {\r\n \"FilterExpressions\": [\r\n { \r\n \"FieldName\": \"Cli.TelId\",\r\n \"FieldValue\": 18389,\r\n \"FilterFunction\": \"EqualTo\"\r\n }\r\n ]\r\n }\r\n ],\r\n \"SortExpressions\": [\r\n {\r\n \"FieldName\": \"LastUpdated\",\r\n \"SortOrder\": \"Descending\"\r\n }\r\n ],\r\n \"PageNumber\": 1,\r\n \"PageSize\": 50\r\n}","options":{"raw":{"language":"json"}}},"url":"{{mainUrl}}v1/Charge/SearchCliLevelChargesPaged"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\r\n \"ReturnModel\": {\r\n \"CurrentPage\": 1,\r\n \"TotalPages\": 5,\r\n \"TotalItems\": 5,\r\n \"ItemsPerPage\": 1,\r\n \"Items\": [\r\n {\r\n \"Cli\": {\r\n \"TelId\": 18389,\r\n \"PhoneNumber\": \"02380238477\"\r\n },\r\n \"Id\": 19393,\r\n \"Account\": {\r\n \"Id\": 6,\r\n \"AccountNumber\": \"RADIO001\",\r\n \"AccountName\": \"Radio Taxis (Southampton) Ltd\"\r\n },\r\n \"Product\": {\r\n \"Id\": 20,\r\n \"ProductCode\": \"ISDN2 CHANNEL\",\r\n \"Description\": \"ISDN2 Per Channel\",\r\n \"BuyPrice\": 11.0000,\r\n \"UnitPrice\": 13.9500,\r\n \"IsLineRental\": true\r\n },\r\n \"Description\": \"ISDN2 Per Channel\",\r\n \"Quantity\": 6,\r\n \"UnitPrice\": 15.3500,\r\n \"RepeatCode\": 1,\r\n \"StartDate\": \"2014-11-01T00:00:00Z\",\r\n \"EndDate\": null,\r\n \"LastBillledToDate\": \"2022-03-31T00:00:00Z\",\r\n \"ApplyWhenValue\": 1.0000,\r\n \"RefNo\": \"Ref No\",\r\n \"Creator\": \"joebloggs\",\r\n \"CreditOnDisconnection\": true,\r\n \"IsCharged\": false,\r\n \"BuyPrice\": 11.0000,\r\n \"DateChargeAdded\": null,\r\n \"LastUpdated\": \"2024-05-22T14:19:16.8637114+01:00\",\r\n \"ContractEndDate\": null,\r\n \"ContractStartDate\": \"2014-11-01T00:00:00Z\",\r\n \"ContractLength\": 6,\r\n \"UseChargeStartDate\": true,\r\n \"SupplierFilter\": \"Unreconciled\",\r\n \"Dealer\": {\r\n \"Id\": null,\r\n \"AccountNumber\": null,\r\n \"AccountName\": null\r\n }\r\n }\r\n ]\r\n },\r\n \"JobNumber\": null,\r\n \"MayRequireRerate\": false\r\n}"}],"_postman_id":"d71bfe6a-15c5-4a9f-aafb-fa86ceb99e8c"},{"name":"Insert Account Level Charge","id":"12413a33-12cc-4b93-a0d9-52be019449e6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"{\n \"AccountId\": 2,\n \"ProductId\": 13,\n \"Description\": \"Test charge\",\n \"RefNo\": null,\n \"RepeatId\": 2,\n \"Quantity\": 1,\n \"BuyPrice\": 0,\n \"UnitPrice\": 12.85,\n \"StartDate\": \"2024-11-01\",\n \"ContractStartDate\": \"2024-11-01\",\n \"ContractLength\": 12,\n \"UseChargeStartDate\": true,\n \"ApplyWhenValue\": null,\n \"CreditOnDisconnection\": true,\n \"DealerId\": null,\n \"Creator\": \"API\"\n}"},"url":"{{mainUrl}}v1/Charge/InsertAccountLevelCharge","description":"Inserts an Account Level Charge.
\nBelow is a list of mandatory fields:
\n","urlObject":{"path":["Charge","InsertAccountLevelCharge"],"host":["{{mainUrl}}v1"],"query":[],"variable":[]}},"response":[{"id":"bd8f9d92-a18c-4c65-a140-e1ef4b60f8f1","name":"Insert Account Level Charge","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"CustomerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"{\n \"AccountId\": 2,\n \"ProductId\": 13,\n \"Description\": \"Test charge\",\n \"RefNo\": null,\n \"RepeatId\": 2,\n \"Quantity\": 1,\n \"BuyPrice\": 0,\n \"UnitPrice\": 12.85,\n \"StartDate\": \"2024-11-01\",\n \"ContractStartDate\": \"2024-11-01\",\n \"ContractLength\": 12,\n \"UseChargeStartDate\": true,\n \"ApplyWhenValue\": null,\n \"CreditOnDisconnection\": true,\n \"DealerId\": null,\n \"Creator\": \"API\"\n}","options":{"raw":{"language":"json"}}},"url":"{{mainUrl}}v1/Charge/InsertAccountLevelCharge"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"ReturnModel\": {\r\n \"Id\": 38735,\r\n \"Account\": {\r\n \"Id\": 2,\r\n \"AccountNumber\": \"ACC0001\",\r\n \"AccountName\": \"An Account Name Ltd\"\r\n },\r\n \"Product\": {\r\n \"Id\": 13,\r\n \"ProductCode\": \"SUNDRY\",\r\n \"Description\": \"This is a description for SUNDRY item\",\r\n \"BuyPrice\": 1.0000,\r\n \"UnitPrice\": 2.0000,\r\n \"IsLineRental\": false\r\n },\r\n \"Description\": \"Test charge\",\r\n \"Quantity\": 1,\r\n \"UnitPrice\": 12.8500,\r\n \"RepeatCode\": 1,\r\n \"StartDate\": \"2024-11-01T00:00:00Z\",\r\n \"EndDate\": null,\r\n \"LastBillledToDate\": null,\r\n \"ApplyWhenValue\": 0.0000,\r\n \"RefNo\": null,\r\n \"Creator\": \"API\",\r\n \"CreditOnDisconnection\": true,\r\n \"IsCharged\": false,\r\n \"BuyPrice\": 0.0000,\r\n \"DateChargeAdded\": \"2024-11-29T17:13:04.143Z\",\r\n \"LastUpdated\": \"2024-11-29T17:13:04.1420566+00:00\",\r\n \"ContractEndDate\": \"2025-11-01T00:00:00Z\",\r\n \"ContractStartDate\": \"2024-11-01T00:00:00Z\",\r\n \"ContractLength\": 12,\r\n \"UseChargeStartDate\": true,\r\n \"SupplierFilter\": null,\r\n \"Dealer\": {\r\n \"Id\": null,\r\n \"AccountNumber\": null,\r\n \"AccountName\": null\r\n }\r\n },\r\n \"JobNumber\": null,\r\n \"MayRequireRerate\": false\r\n}"}],"_postman_id":"12413a33-12cc-4b93-a0d9-52be019449e6"},{"name":"Insert Cli Level Charge","id":"4482d9a8-7931-4363-925a-904c30bd1bd8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"{\n \"CliId\": 30004,\n \"ProductId\": 13,\n \"Description\": \"Test charge\",\n \"RefNo\": null,\n \"RepeatId\": 2,\n \"Quantity\": 1,\n \"BuyPrice\": 0,\n \"UnitPrice\": 12.85,\n \"StartDate\": \"2024-11-01\",\n \"ContractStartDate\": \"2024-11-01\",\n \"ContractLength\": 12,\n \"UseChargeStartDate\": true,\n \"ApplyWhenValue\": null,\n \"CreditOnDisconnection\": true,\n \"DealerId\": null,\n \"Creator\": \"API\"\n}"},"url":"{{mainUrl}}v1/Charge/InsertCliLevelCharge","description":"Inserts a Cli Level Charge.
\nBelow is a list of mandatory fields:
\n","urlObject":{"path":["Charge","InsertCliLevelCharge"],"host":["{{mainUrl}}v1"],"query":[],"variable":[]}},"response":[{"id":"fac0a52a-5287-4901-86b3-e415bbda391b","name":"Insert Cli Level Charge","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"CustomerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"{\n \"CliId\": 30004,\n \"ProductId\": 13,\n \"Description\": \"Test charge\",\n \"RefNo\": null,\n \"RepeatId\": 2,\n \"Quantity\": 1,\n \"BuyPrice\": 0,\n \"UnitPrice\": 12.85,\n \"StartDate\": \"2024-11-01\",\n \"ContractStartDate\": \"2024-11-01\",\n \"ContractLength\": 12,\n \"UseChargeStartDate\": true,\n \"ApplyWhenValue\": null,\n \"CreditOnDisconnection\": true,\n \"DealerId\": null,\n \"Creator\": \"API\"\n}","options":{"raw":{"language":"json"}}},"url":"{{mainUrl}}v1/Charge/InsertCliLevelCharge"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"ReturnModel\": {\r\n \"Cli\": {\r\n \"TelId\": 30004,\r\n \"PhoneNumber\": \"TestCli\"\r\n },\r\n \"Id\": 38736,\r\n \"Account\": {\r\n \"Id\": 2,\r\n \"AccountNumber\": \"ACC0001\",\r\n \"AccountName\": \"An Account Name Ltd\"\r\n },\r\n \"Product\": {\r\n \"Id\": 13,\r\n \"ProductCode\": \"SUNDRY\",\r\n \"Description\": \"This is a description for SUNDRY item\",\r\n \"BuyPrice\": 1.0000,\r\n \"UnitPrice\": 2.0000,\r\n \"IsLineRental\": false\r\n },\r\n \"Description\": \"Test charge\",\r\n \"Quantity\": 1,\r\n \"UnitPrice\": 12.8500,\r\n \"RepeatCode\": 1,\r\n \"StartDate\": \"2024-11-01T00:00:00Z\",\r\n \"EndDate\": null,\r\n \"LastBillledToDate\": null,\r\n \"ApplyWhenValue\": 0.0000,\r\n \"RefNo\": null,\r\n \"Creator\": \"API\",\r\n \"CreditOnDisconnection\": true,\r\n \"IsCharged\": false,\r\n \"BuyPrice\": 0.0000,\r\n \"DateChargeAdded\": \"2024-11-29T17:13:28.58Z\",\r\n \"LastUpdated\": \"2024-11-29T17:13:28.580291+00:00\",\r\n \"ContractEndDate\": \"2025-11-01T00:00:00Z\",\r\n \"ContractStartDate\": \"2024-11-01T00:00:00Z\",\r\n \"ContractLength\": 12,\r\n \"UseChargeStartDate\": true,\r\n \"SupplierFilter\": null,\r\n \"Dealer\": {\r\n \"Id\": null,\r\n \"AccountNumber\": null,\r\n \"AccountName\": null\r\n }\r\n },\r\n \"JobNumber\": null,\r\n \"MayRequireRerate\": false\r\n}"}],"_postman_id":"4482d9a8-7931-4363-925a-904c30bd1bd8"},{"name":"Search Deleted Charge Paged","id":"171fcaae-9e86-461d-98ec-ea51c2563c43","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access-token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"{ \r\n \"GroupedFilterExpressions\":[\r\n {\r\n \"FilterExpressions\": [\r\n { \r\n \"FieldName\": \"LastUpdated\",\r\n \"FieldValue\": \"2025-01-01T11:44:56.0663903+00:00\",\r\n \"FilterFunction\": \"GreaterThanOrEqualTo\"\r\n }\r\n ]\r\n }\r\n ],\r\n \"SortExpressions\": [\r\n {\r\n \"FieldName\": \"LastUpdated\",\r\n \"SortOrder\": \"Descending\"\r\n }\r\n ],\r\n \"PageNumber\": 1,\r\n \"PageSize\": 50\r\n}"},"url":"{{mainUrl}}v1/Charge/SearchDeletedChargePaged","description":"Searches cli level charge data with pagination and sorting.
\n","urlObject":{"path":["Charge","SearchDeletedChargePaged"],"host":["{{mainUrl}}v1"],"query":[],"variable":[]}},"response":[{"id":"692cd17b-aef5-4854-82eb-317b2b5f48d9","name":"Search Deleted Charge Paged","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"CustomerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"{ \r\n \"GroupedFilterExpressions\":[\r\n {\r\n \"FilterExpressions\": [\r\n { \r\n \"FieldName\": \"LastUpdated\",\r\n \"FieldValue\": \"2025-01-01T11:44:56.0663903+00:00\",\r\n \"FilterFunction\": \"GreaterThanOrEqualTo\"\r\n }\r\n ]\r\n }\r\n ],\r\n \"SortExpressions\": [\r\n {\r\n \"FieldName\": \"LastUpdated\",\r\n \"SortOrder\": \"Descending\"\r\n }\r\n ],\r\n \"PageNumber\": 1,\r\n \"PageSize\": 50\r\n}","options":{"raw":{"language":"json"}}},"url":"{{mainUrl}}v1/Charge/SearchDeletedChargePaged"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnModel\": {\n \"CurrentPage\": 1,\n \"TotalPages\": 1,\n \"TotalItems\": 3,\n \"ItemsPerPage\": 50,\n \"Items\": [\n {\n \"Id\": 194,\n \"ChargeId\": 36315,\n \"LastUpdated\": \"2025-01-11T14:55:35.4499888+01:00\"\n },\n {\n \"Id\": 193,\n \"ChargeId\": 37466,\n \"LastUpdated\": \"2025-01-10T19:36:08.0654247+01:00\"\n },\n {\n \"Id\": 192,\n \"ChargeId\": 37474,\n \"LastUpdated\": \"2025-01-09T11:05:38.6376069+01:00\"\n }\n ]\n },\n \"JobNumber\": null,\n \"MayRequireRerate\": false\n}"}],"_postman_id":"171fcaae-9e86-461d-98ec-ea51c2563c43"},{"name":"Update Account Charge","id":"46a689e1-85ff-4835-a8f3-388b515c461f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"{\n \"Id\": 2330,\n \"ProductId\": 18,\n \"Description\": \"Test Account Level Charge\",\n \"RefNo\": null,\n \"RepeatId\": 2,\n \"Quantity\": 1,\n \"BuyPrice\": 15.87,\n \"UnitPrice\": 94.98,\n \"StartDate\": \"2025-11-01\",\n \"ContractStartDate\": \"2025-11-01\",\n \"ContractLength\": 12,\n \"UseChargeStartDate\": true,\n \"ApplyWhenValue\": null,\n \"CreditOnDisconnection\": true,\n \"DealerId\": null\n}"},"url":"{{mainUrl}}v1/Charge/UpdateAccountCharge","urlObject":{"path":["Charge","UpdateAccountCharge"],"host":["{{mainUrl}}v1"],"query":[],"variable":[]}},"response":[{"id":"d90ba4a6-6fe2-4c3d-8095-d20a1de0ee32","name":"Update Account Charge","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"{\n \"Id\": 2330,\n \"ProductId\": 18,\n \"Description\": \"Test Account Level Charge\",\n \"RefNo\": null,\n \"RepeatId\": 2,\n \"Quantity\": 1,\n \"BuyPrice\": 15.87,\n \"UnitPrice\": 94.98,\n \"StartDate\": \"2025-11-01\",\n \"ContractStartDate\": \"2025-11-01\",\n \"ContractLength\": 12,\n \"UseChargeStartDate\": true,\n \"ApplyWhenValue\": null,\n \"CreditOnDisconnection\": true,\n \"DealerId\": null\n}","options":{"raw":{"language":"json"}}},"url":"{{mainUrl}}v1/Charge/UpdateAccountCharge"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnModel\": {\n \"Id\": 2330,\n \"Account\": {\n \"Id\": 42,\n \"AccountNumber\": \"KJ01\",\n \"AccountName\": \"KJ Test\"\n },\n \"Product\": {\n \"Id\": 18,\n \"ProductCode\": \"ISDN2_INSTALL\",\n \"Description\": \"ISDN2 Installation\",\n \"BuyPrice\": 0,\n \"UnitPrice\": 99,\n \"IsLineRental\": false\n },\n \"Description\": \"Test Account Level Charge\",\n \"Quantity\": 1,\n \"UnitPrice\": 94.98,\n \"RepeatId\": 2,\n \"StartDate\": \"2025-11-01T00:00:00Z\",\n \"EndDate\": null,\n \"LastBillledToDate\": null,\n \"ApplyWhenValue\": 0,\n \"RefNo\": null,\n \"Creator\": \"inform_janed\",\n \"CreditOnDisconnection\": true,\n \"IsCharged\": false,\n \"BuyPrice\": 15.87,\n \"DateChargeAdded\": \"2026-05-05T17:18:12.277Z\",\n \"LastUpdated\": \"2026-05-06T15:00:19.8864983+01:00\",\n \"ContractEndDate\": \"2026-10-31T00:00:00Z\",\n \"ContractStartDate\": \"2025-11-01T00:00:00Z\",\n \"ContractLength\": 12,\n \"UseChargeStartDate\": true,\n \"SupplierFilter\": \"\",\n \"Dealer\": {\n \"Id\": null,\n \"AccountNumber\": null,\n \"AccountName\": null\n }\n },\n \"JobNumber\": null,\n \"MayRequireRerate\": true\n}"}],"_postman_id":"46a689e1-85ff-4835-a8f3-388b515c461f"},{"name":"Update Cli Charge","id":"aeafe0c0-fd8c-4470-be29-a043a5219fce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"{\n \"Id\": 2329,\n \"ProductId\": 37,\n \"Description\": \"Test Cli Level Charge\",\n \"RefNo\": null,\n \"RepeatId\": 2,\n \"Quantity\": 1,\n \"BuyPrice\": 12.25,\n \"UnitPrice\": 394.0000,\n \"StartDate\": \"2025-11-01\",\n \"ContractStartDate\": \"2025-11-01\",\n \"ContractLength\": 12,\n \"UseChargeStartDate\": true,\n \"ApplyWhenValue\": null,\n \"CreditOnDisconnection\": true,\n \"DealerId\": null\n}"},"url":"{{mainUrl}}v1/Charge/UpdateCliCharge","urlObject":{"path":["Charge","UpdateCliCharge"],"host":["{{mainUrl}}v1"],"query":[],"variable":[]}},"response":[{"id":"14aacac3-9c33-4981-894f-ffc06ad66c80","name":"Update Cli Charge","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"{\n \"Id\": 2329,\n \"ProductId\": 37,\n \"Description\": \"Test Cli Level Charge\",\n \"RefNo\": null,\n \"RepeatId\": 2,\n \"Quantity\": 1,\n \"BuyPrice\": 12.25,\n \"UnitPrice\": 394.0000,\n \"StartDate\": \"2025-11-01\",\n \"ContractStartDate\": \"2025-11-01\",\n \"ContractLength\": 12,\n \"UseChargeStartDate\": true,\n \"ApplyWhenValue\": null,\n \"CreditOnDisconnection\": true,\n \"DealerId\": null\n}","options":{"raw":{"language":"json"}}},"url":"{{mainUrl}}v1/Charge/UpdateCliCharge"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnModel\": {\n \"Cli\": {\n \"TelId\": 4457,\n \"PhoneNumber\": \"CSLIoT_CLI48\"\n },\n \"Id\": 2329,\n \"Account\": {\n \"Id\": 7040,\n \"AccountNumber\": \"CSLTest001\",\n \"AccountName\": \"CSL Testing Account\"\n },\n \"Product\": {\n \"Id\": 37,\n \"ProductCode\": \"ISDN30_CL3\",\n \"Description\": \"ISDN30 Care Level 3\",\n \"BuyPrice\": 0,\n \"UnitPrice\": 3,\n \"IsLineRental\": true\n },\n \"Description\": \"Test Cli Level Charge\",\n \"Quantity\": 1,\n \"UnitPrice\": 394,\n \"RepeatId\": 2,\n \"StartDate\": \"2025-11-01T00:00:00Z\",\n \"EndDate\": null,\n \"LastBillledToDate\": null,\n \"ApplyWhenValue\": 0,\n \"RefNo\": null,\n \"Creator\": \"Portal\",\n \"CreditOnDisconnection\": true,\n \"IsCharged\": false,\n \"BuyPrice\": 12.25,\n \"DateChargeAdded\": \"2026-02-19T23:18:30.9Z\",\n \"LastUpdated\": \"2026-05-06T15:05:22.2687174+01:00\",\n \"ContractEndDate\": \"2026-10-31T00:00:00Z\",\n \"ContractStartDate\": \"2025-11-01T00:00:00Z\",\n \"ContractLength\": 12,\n \"UseChargeStartDate\": true,\n \"SupplierFilter\": null,\n \"Dealer\": {\n \"Id\": null,\n \"AccountNumber\": null,\n \"AccountName\": null\n }\n },\n \"JobNumber\": null,\n \"MayRequireRerate\": true\n}"}],"_postman_id":"aeafe0c0-fd8c-4470-be29-a043a5219fce"}],"id":"30d5a96e-f6ed-4cb9-8be2-c98f48f968b6","_postman_id":"30d5a96e-f6ed-4cb9-8be2-c98f48f968b6","description":""}],"id":"865e2af6-e5d3-4973-a5e7-2cdba3851424","description":"Contains endpoints relating to the charge.
\n","_postman_id":"865e2af6-e5d3-4973-a5e7-2cdba3851424"},{"name":"Charge Repeat","item":[{"name":"v1","item":[{"name":"Get Charge Repeats","id":"2278cc0f-ab47-482c-9fcf-dbf5e6e73a03","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":""},"url":"{{mainUrl}}v1/ChargeRepeat/GetChargeRepeats","urlObject":{"path":["ChargeRepeat","GetChargeRepeats"],"host":["{{mainUrl}}v1"],"query":[],"variable":[]}},"response":[{"id":"144547d6-7cc0-42fb-8610-56381421c549","name":"Get Charge Repeats","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"url":"{{mainUrl}}v1/ChargeRepeat/GetChargeRepeats"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnModel\": [\n {\n \"Id\": 1,\n \"RepeatDescription\": \"Do not repeat - one off\"\n },\n {\n \"Id\": 2,\n \"RepeatDescription\": \"Every month\"\n },\n {\n \"Id\": 3,\n \"RepeatDescription\": \"Every quarter\"\n },\n {\n \"Id\": 4,\n \"RepeatDescription\": \"Every six months\"\n },\n {\n \"Id\": 5,\n \"RepeatDescription\": \"Every year\"\n },\n {\n \"Id\": 6,\n \"RepeatDescription\": \"Every two years\"\n },\n {\n \"Id\": 7,\n \"RepeatDescription\": \"Only when bill is less than\"\n },\n {\n \"Id\": 8,\n \"RepeatDescription\": \"Only when bill is greater than\"\n },\n {\n \"Id\": 9,\n \"RepeatDescription\": \"Every month (anniversary)\"\n },\n {\n \"Id\": 10,\n \"RepeatDescription\": \"Every six months (anniversary)\"\n },\n {\n \"Id\": 11,\n \"RepeatDescription\": \"Every quarter (anniversary)\"\n },\n {\n \"Id\": 12,\n \"RepeatDescription\": \"Every year (anniversary)\"\n },\n {\n \"Id\": 13,\n \"RepeatDescription\": \"Every two years (anniversary)\"\n },\n {\n \"Id\": 15,\n \"RepeatDescription\": \"Every three years (anniversary)\"\n },\n {\n \"Id\": 14,\n \"RepeatDescription\": \"Every three years\"\n }\n ],\n \"JobNumber\": null,\n \"MayRequireRerate\": false\n}"}],"_postman_id":"2278cc0f-ab47-482c-9fcf-dbf5e6e73a03"}],"id":"f1c409fa-094e-46f0-9e6f-31c11c2a0cfc","_postman_id":"f1c409fa-094e-46f0-9e6f-31c11c2a0cfc","description":""}],"id":"f56a821e-21ed-4946-846c-67bed5faf56b","description":"Contains endpoints relating to the charge repeat.
\n","_postman_id":"f56a821e-21ed-4946-846c-67bed5faf56b"},{"name":"Price List","item":[{"name":"v1","item":[{"name":"Search Price List Paged","id":"4f486db5-e2e5-4323-9a77-86859bcc91be","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access-token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"{ \n \"GroupedFilterExpressions\":[\n {\n \"FilterExpressions\": [\n { \n \"FieldName\": \"Id\",\n \"FieldValue\": 1,\n \"FilterFunction\": \"EqualTo\"\n }\n ]\n }\n ],\n \"SortExpressions\": [\n {\n \"FieldName\": \"PriceListLastUpdated\",\n \"SortOrder\": \"Ascending\"\n }\n ],\n \"PageNumber\": 1,\n \"PageSize\": 50\n}"},"url":"{{mainUrl}}v1/PriceList/SearchPriceListPaged","description":"Searches price list data with pagination and sorting.
\n","urlObject":{"path":["PriceList","SearchPriceListPaged"],"host":["{{mainUrl}}v1"],"query":[],"variable":[]}},"response":[{"id":"c29bd189-0c75-4e35-ae8c-0631adc319dc","name":"Search Price List Paged","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"{ \n \"GroupedFilterExpressions\":[\n {\n \"FilterExpressions\": [\n { \n \"FieldName\": \"Id\",\n \"FieldValue\": 1,\n \"FilterFunction\": \"EqualTo\"\n }\n ]\n }\n ],\n \"SortExpressions\": [\n {\n \"FieldName\": \"PriceListLastUpdated\",\n \"SortOrder\": \"Ascending\"\n }\n ],\n \"PageNumber\": 1,\n \"PageSize\": 50\n}","options":{"raw":{"language":"json"}}},"url":"{{mainUrl}}v1/PriceList/SearchPriceListPaged"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\r\n \"CurrentPage\": 1,\r\n \"TotalPages\": 1,\r\n \"TotalItems\": 3,\r\n \"ItemsPerPage\": 50,\r\n \"Items\": [\r\n {\r\n \"Id\": 2,\r\n \"PriceListName\": \"Amy's Price List\",\r\n \"PriceListLastUpdated\": \"2024-07-16T17:08:43.1384689+01:00\",\r\n \"PriceListLineId\": 36,\r\n \"Product\": {\r\n \"Id\": 13,\r\n \"ProductCode\": \"S_PSTN_LR\",\r\n \"Description\": \"Single PSTN Line Rental\"\r\n },\r\n \"PriceListLinePrice\": 12.9900,\r\n \"PriceListLineAvailable\": true,\r\n \"PriceListLineSupplierChargeMarkup\": 0.00,\r\n \"PriceListLineUseSupplierChargeMarkup\": false\r\n },\r\n {\r\n \"Id\": 2,\r\n \"PriceListName\": \"Amy's Price List\",\r\n \"PriceListLastUpdated\": \"2024-07-16T17:08:43.1384689+01:00\",\r\n \"PriceListLineId\": 37,\r\n \"Product\": {\r\n \"Id\": 14,\r\n \"ProductCode\": \"ML_PSTN_LR\",\r\n \"Description\": \"Multi PSTN Line Rental\"\r\n },\r\n \"PriceListLinePrice\": 12.9900,\r\n \"PriceListLineAvailable\": true,\r\n \"PriceListLineSupplierChargeMarkup\": 0.00,\r\n \"PriceListLineUseSupplierChargeMarkup\": false\r\n },\r\n {\r\n \"Id\": 2,\r\n \"PriceListName\": \"Amy's Price List\",\r\n \"PriceListLastUpdated\": \"2024-07-16T17:08:43.1384689+01:00\",\r\n \"PriceListLineId\": 38,\r\n \"Product\": {\r\n \"Id\": 16,\r\n \"ProductCode\": \"ISDN2_LR\",\r\n \"Description\": \"ISDN2 Line Rental (per 2 channels)\"\r\n },\r\n \"PriceListLinePrice\": 12.5000,\r\n \"PriceListLineAvailable\": true,\r\n \"PriceListLineSupplierChargeMarkup\": 0.00,\r\n \"PriceListLineUseSupplierChargeMarkup\": false\r\n }\r\n ]\r\n}"}],"_postman_id":"4f486db5-e2e5-4323-9a77-86859bcc91be"}],"id":"43cd1334-c3dc-409c-9dc6-16bfe1056639","_postman_id":"43cd1334-c3dc-409c-9dc6-16bfe1056639","description":""}],"id":"adf3381f-3af2-46c8-a084-2d46512c8ee2","description":"Contains endpoints relating to the price list.
\n","_postman_id":"adf3381f-3af2-46c8-a084-2d46512c8ee2"},{"name":"Product","item":[{"name":"v1","item":[{"name":"Search Product Paged","id":"d6b1daf7-2165-473b-9274-949fc489efc5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access-token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"{ \n \"GroupedFilterExpressions\": [\n {\n \"FilterExpressions\":\n [\n {\n \"FieldName\": \"ProductCode\",\n \"FieldValue\": \"CE\",\n \"FilterFunction\": \"StartsWith\"\n }\n ]\n }\n ], \n \"SortExpressions\": [\n {\n \"FieldName\": \"Id\",\n \"SortOrder\": \"Descending\"\n }\n ],\n \"PageNumber\": 1,\n \"PageSize\": 50\n}"},"url":"{{mainUrl}}v1/Product/SearchProductPaged","description":"Searches product data with pagination and sorting.
\n","urlObject":{"path":["Product","SearchProductPaged"],"host":["{{mainUrl}}v1"],"query":[],"variable":[]}},"response":[{"id":"3a96e239-1905-4eca-99dd-7a96f289ab23","name":"Search Product Paged","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"{ \n \"GroupedFilterExpressions\": [\n {\n \"FilterExpressions\":\n [\n {\n \"FieldName\": \"ProductCode\",\n \"FieldValue\": \"CE\",\n \"FilterFunction\": \"StartsWith\"\n }\n ]\n }\n ], \n \"SortExpressions\": [\n {\n \"FieldName\": \"Id\",\n \"SortOrder\": \"Descending\"\n }\n ],\n \"PageNumber\": 1,\n \"PageSize\": 50\n}","options":{"raw":{"language":"json"}}},"url":"{{mainUrl}}v1/Product/SearchProductPaged"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\r\n \"ReturnModel\": {\r\n \"CurrentPage\": 1,\r\n \"TotalPages\": 1,\r\n \"TotalItems\": 1,\r\n \"ItemsPerPage\": 50,\r\n \"Items\": [\r\n {\r\n \"Id\": 48,\r\n \"ProductCode\": \"CEASE\",\r\n \"ProductType\": {\r\n \"Id\": 14,\r\n \"Name\": \"SUND\",\r\n \"Description\": \"General Sundry Items\"\r\n },\r\n \"Description\": \"Cease fee\",\r\n \"BuyPrice\": 100.0000,\r\n \"UnitPrice\": 17.9900,\r\n \"UnitWeight\": 2.0000,\r\n \"ProductStatus\": {\r\n \"Id\": 2,\r\n \"Description\": \"Current\"\r\n },\r\n \"FreeFormprice\": true,\r\n \"NominalCode\": \"Nominal Code\",\r\n \"TaxBandId\": 2,\r\n \"DefaultRepeatCode\": 1,\r\n \"CarrierId\": 1,\r\n \"IsLineRental\": false,\r\n \"Notes\": \"Notes\",\r\n \"ProductAnalysis1\": {\r\n \"Id\": 1,\r\n \"Description\": \"Analysis 1 Description\",\r\n \"LastUpdated\": \"2024-05-31T12:40:11.8011237+01:00\"\r\n },\r\n \"ProductAnalysis2\": {\r\n \"Id\": 1,\r\n \"Description\": \"Analysis 2 Description\",\r\n \"LastUpdated\": \"2024-05-31T12:40:33.6512281+01:00\"\r\n },\r\n \"BuyNominalCode\": \"1GG3\",\r\n \"ProductDepartment\": {\r\n \"Id\": 1,\r\n \"Description\": \"Accounting\",\r\n \"LastUpdated\": \"2024-05-31T12:40:11.8011237+01:00\"\r\n },\r\n \"ProductItemType\": {\r\n \"Id\": 1,\r\n \"Description\": \"Item type description sample\",\r\n \"LastUpdated\": \"2024-05-31T12:40:11.8011237+01:00\"\r\n },\r\n \"SupplierPartNumber\": \"GX123\",\r\n \"CreatedDate\": \"2015-12-22T00:00:00Z\",\r\n \"SupplierChargeMarkup\": 1.23,\r\n \"UseSupplierChargeMarkup\": true,\r\n \"LastUpdated\": \"2024-06-05T15:39:05.3785381+01:00\"\r\n }\r\n ]\r\n },\r\n \"JobNumber\": null,\r\n \"MayRequireRerate\": false\r\n}"}],"_postman_id":"d6b1daf7-2165-473b-9274-949fc489efc5"},{"name":"Get Product Status List","id":"494ce989-ef41-4ff4-96ff-73e8534cb7a8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access-token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":""},"url":"{{mainUrl}}v1/Product/GetProductStatusList","description":"Gets the available product statuses
\n","urlObject":{"path":["Product","GetProductStatusList"],"host":["{{mainUrl}}v1"],"query":[],"variable":[]}},"response":[{"id":"bc2bb88d-5721-43e6-b067-30f48a0221a1","name":"Get Product Status List","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"url":"{{mainUrl}}v1/Product/GetProductStatusList"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnModel\": [\n {\n \"Id\": 1,\n \"Description\": \"Current\"\n },\n {\n \"Id\": 2,\n \"Description\": \"Discontinued\"\n }\n ],\n \"JobNumber\": null,\n \"MayRequireRerate\": false\n}"}],"_postman_id":"494ce989-ef41-4ff4-96ff-73e8534cb7a8"}],"id":"342686af-2504-46b5-9684-82c20b7fa493","_postman_id":"342686af-2504-46b5-9684-82c20b7fa493","description":""}],"id":"cd898151-5362-453f-a459-abbc9300a100","description":"Contains endpoints relating to the product.
\n","_postman_id":"cd898151-5362-453f-a459-abbc9300a100"}],"id":"df2d2f02-e0d9-46ea-8c80-33683b0192fd","description":"Contains endpoints relating to the charge, charge repeat, price list and product.
\n","_postman_id":"df2d2f02-e0d9-46ea-8c80-33683b0192fd"},{"name":"CLI","item":[{"name":"CLI","item":[{"name":"v1","item":[{"name":"Search CLI Paged","id":"e48de94a-aa47-499a-bddb-cc2127586ebd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access-token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"{ \n \"GroupedFilterExpressions\": [\n {\n \"FilterExpressions\": [\n {\n \"FieldName\": \"ConnectionDate\",\n \"FieldValue\": \"2024-06-01T00:00:00Z\",\n \"FilterFunction\": \"GreaterThanOrEqualTo\"\n }\n ],\n \"FilterExpressionsUsingOR\": false\n }\n ], \n \"SortExpressions\": [\n {\n \"FieldName\": \"ConnectionDate\",\n \"SortOrder\": \"Descending\"\n }\n ],\n \"PageNumber\": 1,\n \"PageSize\": 50\n}"},"url":"{{mainUrl}}v1/CLI/SearchCliPaged","description":"NOTE: This endpoint is now obsolete and will become unavailable from 2025-12-31.
The V2 Search Cli Paged endpoint should be used for all new development and any existing use should be migrated.
Searches CLI data with pagination and sorting.
\n","urlObject":{"path":["CLI","SearchCliPaged"],"host":["{{mainUrl}}v1"],"query":[],"variable":[]}},"response":[{"id":"c89791e0-5d66-4d22-92eb-42b26000924f","name":"Search CLI Paged","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"{ \n \"GroupedFilterExpressions\": [\n {\n \"FilterExpressions\": [\n {\n \"FieldName\": \"ConnectionDate\",\n \"FieldValue\": \"2024-06-01T00:00:00Z\",\n \"FilterFunction\": \"GreaterThanOrEqualTo\"\n }\n ],\n \"FilterExpressionsUsingOR\": false\n }\n ], \n \"SortExpressions\": [\n {\n \"FieldName\": \"ConnectionDate\",\n \"SortOrder\": \"Descending\"\n }\n ],\n \"PageNumber\": 1,\n \"PageSize\": 50\n}","options":{"raw":{"language":"json"}}},"url":"{{mainUrl}}v1/CLI/SearchCliPaged"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Obsolete","value":"2025-12-31","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnModel\": {\n \"CurrentPage\": 1,\n \"TotalPages\": 1,\n \"TotalItems\": 1,\n \"ItemsPerPage\": 50,\n \"Items\": [\n {\n \"CliId\": 1050,\n \"Cli\": \"NG3831CLI12\",\n \"BillPlanId\": 1956,\n \"CustomerAccountId\": 2,\n \"BillingCompanyId\": 4,\n \"NumberDescription\": \"CLI Description\",\n \"CostCentre\": \"Cost Centre\",\n \"NumberTypeId\": \"Fixed\",\n \"ConnectionDate\": \"2024-06-01T00:00:00Z\",\n \"DisconnectionDate\": null,\n \"EmailAddress\": \"joebloggs@informbilling.co.uk\",\n \"EquipmentId\": 0,\n \"EquipmentSerialNo\": \"Equipment Serial No\",\n \"NumberOfLines\": 0,\n \"NumberOfChannels\": 0,\n \"LineTypeId\": 0,\n \"AddressDetailsAccountNumber\": \"Address Details Account Number\",\n \"AddressDetailsAccountName\": \"Address Details Account Name\",\n \"AddressDetailsAddress\": \"Address Details Address\",\n \"AddressDetailsPostcode\": \"Address Details Postcode\",\n \"AddressDetailsWholesaleOrderNo\": \"Address Details Wholesale Order No\",\n \"CPSCentrexRef\": \"CPS Centrex Ref\",\n \"CPSOrderNumber\": \"CPS Order Number\",\n \"CPSOptionId\": \"CPS Option Id\",\n \"SIM\": \"SIM\",\n \"PUK\": \"PUK\",\n \"MailboxNumber\": \"Mailbox Number\",\n \"DataNumber\": \"Data Number\",\n \"FaxNumber\": \"Fax Number\",\n \"RestrictedNumbers\": \"Restricted Numbers\",\n \"CarrierContractStartDate\": \"2020-03-01T00:00:00Z\",\n \"CarrierContractEndDate\": \"2020-04-01T00:00:00Z\",\n \"CarrierContractLength\": 1,\n \"CarrierContractContractTypeId\": 1,\n \"UserContractStartDate\": \"2023-05-18T00:00:00Z\",\n \"UserContractEndDate\": \"2024-05-18T00:00:00Z\",\n \"UserContractLength\": 12,\n \"UserContractContractTypeId\": 1,\n \"PAC\": \"PAC\",\n \"ShortCode\": \"Short Code\",\n \"RoutingPlan\": 0,\n \"DestP2PNumber\": \"Dest P2P Number\",\n \"Custom1\": \"Custom1\",\n \"Custom2\": \"Custom2\",\n \"Custom3\": \"Custom3\",\n \"Custom4\": \"Custom4\",\n \"Custom5\": \"Custom5\",\n \"Custom6\": \"Custom6\",\n \"Custom7\": \"Custom7\",\n \"Custom8\": \"Custom8\",\n \"Custom9\": \"Custom9\",\n \"Custom10\": \"Custom10\",\n \"Custom11\": \"Custom11\",\n \"Custom12\": \"Custom12\",\n \"Custom13\": \"Custom13\",\n \"Custom14\": \"Custom14\",\n \"Custom15\": \"Custom15\",\n \"PrintSummary\": true,\n \"PrintAnalysis\": true,\n \"PrintItemisation\": true,\n \"EmailSummaryToAccount\": true,\n \"EmailAnalysisToAccount\": true,\n \"EmailItemisationToAccount\": true,\n \"EmailSummaryToBillPlan\": true,\n \"EmailAnalysisToBillPlan\": true,\n \"EmailItemisationToBillPlan\": true,\n \"EmailSummaryToCLI\": true,\n \"EmailAnalysisToCLI\": true,\n \"EmailItemisationToCLI\": true,\n \"AnalysisStyle\": 1,\n \"ShowSavingOnSummary\": true,\n \"Creator\": \"joebloggs\",\n \"EmailCDRsToAccount\": true,\n \"EmailCDRsToBillPlan\": true,\n \"EmailCDRsToCLI\": true,\n \"NTSClassValue\": 0,\n \"CreatedDate\": \"2023-03-20T11:53:56.533Z\",\n \"NumberTypeValue\": 2,\n \"NTSTypeId\": 0,\n \"IsDisconnected\": false,\n \"MobileLimitEnabled\": true,\n \"MobileLimitWarning\": 10.2,\n \"MobileLimitLimit\": 11.2,\n \"DealerId\": 1,\n \"LowerBundleLimit\": 80,\n \"UpperBundleLimit\": 100,\n \"LowerAlertSpendLimit\": 50,\n \"UpperAlertSpendLimit\": 60,\n \"DataLimitEnabled\": true,\n \"DataLimitWarning\": 1,\n \"DataWarningUnitValue\": 1,\n \"DataLimitLimit\": 1,\n \"DataLimitUnitValue\": 1,\n \"TransferredToTelId\": 1,\n \"EID\": \"Example EID\",\n \"IMSI\": \"Example IMSI\",\n \"ConnectionId\": \"Example Connection Id\",\n \"IsPrimaryConnection\": true,\n \"LastUpdated\": \"2024-06-06T15:20:10.2682369+01:00\"\n }\n ]\n },\n \"JobNumber\": null,\n \"MayRequireRerate\": false\n}"}],"_postman_id":"e48de94a-aa47-499a-bddb-cc2127586ebd"},{"name":"Insert Fixed CLI","id":"2e156be4-1ba8-4241-a218-76c271feceb6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access-token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"customerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"{\r\n \"Cli\": \"APIFixed001\",\r\n \"BillPlanId\": 1963, \r\n \"NumberDescription\": \"API_Fixed_001\",\r\n \"CostCentre\": \"000\",\r\n \"ConnectionDate\": \"2024-01-01T00:00:00Z\",\r\n \"EmailAddress\": \"apifixedtest@informbilling.co.uk\",\r\n \"EquipmentId\": null,\r\n \"EquipmentSerialNo\": null,\r\n \"AddressDetailsAccountNumber\": null,\r\n \"AddressDetailsAccountName\": null,\r\n \"AddressDetailsAddress\": null,\r\n \"AddressDetailsPostcode\": null,\r\n \"AddressDetailsWholesaleOrderNo\": null, \r\n \"MailboxNumber\": null,\r\n \"DataNumber\": null,\r\n \"FaxNumber\": null,\r\n \"CarrierContractStartDate\": \"2024-01-01T00:00:00\",\r\n \"CarrierContractLength\": 12,\r\n \"CarrierContractTypeId\": 1,\r\n \"UserContractStartDate\": \"2024-01-01T00:00:00\",\r\n \"UserContractLength\": 12,\r\n \"UserContractTypeId\": 2,\r\n \"UserDefinedField\":{\r\n \"Custom1\": null,\r\n \"Custom2\": null,\r\n \"Custom3\": null,\r\n \"Custom4\": null,\r\n \"Custom5\": null,\r\n \"Custom6\": null,\r\n \"Custom7\": null,\r\n \"Custom8\": null,\r\n \"Custom9\": \"Twst1\",\r\n \"Custom10\": null,\r\n \"Custom11\": null,\r\n \"Custom12\": null,\r\n \"Custom13\": null,\r\n \"Custom14\": null,\r\n \"Custom15\": null\r\n },\r\n \"PrintSummary\": false,\r\n \"PrintAnalysis\": false,\r\n \"PrintItemisation\": false,\r\n \"EmailSummaryToAccount\": true,\r\n \"EmailAnalysisToAccount\": false,\r\n \"EmailItemisationToAccount\": false,\r\n \"EmailSummaryToBillPlan\": false,\r\n \"EmailAnalysisToBillPlan\": false,\r\n \"EmailItemisationToBillPlan\": false,\r\n \"EmailSummaryToCLI\": false,\r\n \"EmailAnalysisToCLI\": false,\r\n \"EmailItemisationToCLI\": false,\r\n \"AnalysisStyleId\": 1,\r\n \"ShowSavingOnSummary\": false,\r\n \"Creator\": \"admin\",\r\n \"EmailCDRsToAccount\": false,\r\n \"EmailCDRsToBillPlan\": false,\r\n \"EmailCDRsToCLI\": false,\r\n \"DealerId\": null, \r\n \"EID\": null,\r\n \"IMSI\": null,\r\n \"ConnectionId\": \"\",\r\n \"IsPrimaryConnection\": true\r\n} \r\n","options":{"raw":{"language":"json"}}},"url":"{{mainUrl}}v1/CLI/InsertCliFixed","description":"Inserts a Fixed Cli Type Cli.
\nBelow is a list of mandatory fields:
\n","urlObject":{"path":["CLI","InsertCliFixed"],"host":["{{mainUrl}}v1"],"query":[],"variable":[]}},"response":[{"id":"7274b3cd-56be-4b2d-8d40-3fd408f3d321","name":"Insert Fixed CLI","originalRequest":{"method":"POST","header":[{"key":"customerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"{\r\n \"Cli\": \"APIFixed001\",\r\n \"BillPlanId\": 1963, \r\n \"NumberDescription\": \"API_Fixed_001\",\r\n \"CostCentre\": \"000\",\r\n \"ConnectionDate\": \"2024-01-01T00:00:00Z\",\r\n \"EmailAddress\": \"apifixedtest@informbilling.co.uk\",\r\n \"EquipmentId\": null,\r\n \"EquipmentSerialNo\": null,\r\n \"AddressDetailsAccountNumber\": null,\r\n \"AddressDetailsAccountName\": null,\r\n \"AddressDetailsAddress\": null,\r\n \"AddressDetailsPostcode\": null,\r\n \"AddressDetailsWholesaleOrderNo\": null, \r\n \"MailboxNumber\": null,\r\n \"DataNumber\": null,\r\n \"FaxNumber\": null,\r\n \"CarrierContractStartDate\": \"2024-01-01T00:00:00\",\r\n \"CarrierContractLength\": 12,\r\n \"CarrierContractTypeId\": 1,\r\n \"UserContractStartDate\": \"2024-01-01T00:00:00\",\r\n \"UserContractLength\": 12,\r\n \"UserContractTypeId\": 2,\r\n \"UserDefinedField\":{\r\n \"Custom1\": null,\r\n \"Custom2\": null,\r\n \"Custom3\": null,\r\n \"Custom4\": null,\r\n \"Custom5\": null,\r\n \"Custom6\": null,\r\n \"Custom7\": null,\r\n \"Custom8\": null,\r\n \"Custom9\": \"Custom 9\",\r\n \"Custom10\": null,\r\n \"Custom11\": null,\r\n \"Custom12\": null,\r\n \"Custom13\": null,\r\n \"Custom14\": null,\r\n \"Custom15\": null\r\n },\r\n \"PrintSummary\": false,\r\n \"PrintAnalysis\": false,\r\n \"PrintItemisation\": false,\r\n \"EmailSummaryToAccount\": true,\r\n \"EmailAnalysisToAccount\": false,\r\n \"EmailItemisationToAccount\": false,\r\n \"EmailSummaryToBillPlan\": false,\r\n \"EmailAnalysisToBillPlan\": false,\r\n \"EmailItemisationToBillPlan\": false,\r\n \"EmailSummaryToCLI\": false,\r\n \"EmailAnalysisToCLI\": false,\r\n \"EmailItemisationToCLI\": false,\r\n \"AnalysisStyleId\": 1,\r\n \"ShowSavingOnSummary\": false,\r\n \"Creator\": \"admin\",\r\n \"EmailCDRsToAccount\": false,\r\n \"EmailCDRsToBillPlan\": false,\r\n \"EmailCDRsToCLI\": false,\r\n \"DealerId\": null, \r\n \"EID\": null,\r\n \"IMSI\": null,\r\n \"ConnectionId\": \"\",\r\n \"IsPrimaryConnection\": true\r\n} \r\n","options":{"raw":{"language":"json"}}},"url":"{{mainUrl}}v1/CLI/InsertCliFixed"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnModel\": {\n \"CliId\": 30012,\n \"Cli\": \"APIFixed001\",\n \"BillPlan\": {\n \"Id\": 1963,\n \"Name\": \"Test Company Ltd\"\n },\n \"CustomerAccount\": {\n \"Id\": 5,\n \"AccountNumber\": \"TEST0001\",\n \"Name\": \"Test Company Ltd\"\n },\n \"BillingCompany\": {\n \"Id\": 4,\n \"Name\": \"Test Company Ltd\"\n },\n \"NumberDescription\": \"API_Fixed_001\",\n \"CostCentre\": \"000\",\n \"CliType\": {\n \"Id\": 1,\n \"Description\": \"Fixed\"\n },\n \"ConnectionDate\": \"2024-01-01T00:00:00Z\",\n \"DisconnectionDate\": null,\n \"EmailAddress\": \"apifixedtest@informbilling.co.uk\",\n \"EquipmentType\": null,\n \"EquipmentSerialNo\": null,\n \"NumberOfLines\": 0,\n \"NumberOfChannels\": 0,\n \"AddressDetailsAccountNumber\": null,\n \"AddressDetailsAccountName\": null,\n \"AddressDetailsAddress\": null,\n \"AddressDetailsPostcode\": null,\n \"AddressDetailsWholesaleOrderNo\": null,\n \"CPSCentrexRef\": null,\n \"CPSOrderNumber\": null,\n \"CPSOptionId\": null,\n \"SIM\": null,\n \"PUK\": null,\n \"MailboxNumber\": null,\n \"DataNumber\": null,\n \"FaxNumber\": null,\n \"RestrictedNumbers\": null,\n \"CarrierContractStartDate\": \"2024-01-01T00:00:00Z\",\n \"CarrierContractEndDate\": \"2025-01-01T00:00:00Z\",\n \"CarrierContractLength\": 12,\n \"CarrierContractContractType\": {\n \"Id\": 1,\n \"ContractType\": \"New Number\",\n \"CliType\": {\n \"Id\": 1,\n \"Description\": \"Fixed\"\n }\n },\n \"UserContractStartDate\": \"2024-01-01T00:00:00Z\",\n \"UserContractEndDate\": \"2025-01-01T00:00:00Z\",\n \"UserContractLength\": 12,\n \"UserContractContractType\": {\n \"Id\": 2,\n \"ContractType\": \"Migration (Line Takeover)\",\n \"CliType\": {\n \"Id\": 1,\n \"Description\": \"Fixed\"\n }\n },\n \"PAC\": null,\n \"ShortCode\": null,\n \"RoutingPlan\": null,\n \"DestP2PNumber\": null,\n \"UserDefinedField\": {\n \"Id\": 30012,\n \"Custom1\": null,\n \"Custom2\": null,\n \"Custom3\": null,\n \"Custom4\": null,\n \"Custom5\": null,\n \"Custom6\": null,\n \"Custom7\": null,\n \"Custom8\": null,\n \"Custom9\": \"Custom 9\",\n \"Custom10\": null,\n \"Custom11\": null,\n \"Custom12\": null,\n \"Custom13\": null,\n \"Custom14\": null,\n \"Custom15\": null\n },\n \"PrintSummary\": false,\n \"PrintAnalysis\": false,\n \"PrintItemisation\": false,\n \"EmailSummaryToAccount\": true,\n \"EmailAnalysisToAccount\": false,\n \"EmailItemisationToAccount\": false,\n \"EmailSummaryToBillPlan\": false,\n \"EmailAnalysisToBillPlan\": false,\n \"EmailItemisationToBillPlan\": false,\n \"EmailSummaryToCLI\": false,\n \"EmailAnalysisToCLI\": false,\n \"EmailItemisationToCLI\": false,\n \"AnalysisStyleId\": 1,\n \"ShowSavingOnSummary\": false,\n \"Creator\": \"admin\",\n \"EmailCDRsToAccount\": false,\n \"EmailCDRsToBillPlan\": false,\n \"EmailCDRsToCLI\": false,\n \"NTSClass\": null,\n \"NTSType\": null,\n \"CreatedDate\": \"2024-11-12T16:21:26.5Z\",\n \"IsDisconnected\": false,\n \"MobileLimitEnabled\": false,\n \"MobileLimitWarning\": null,\n \"MobileLimitLimit\": null,\n \"Dealer\": null,\n \"LowerBundleLimit\": 80,\n \"UpperBundleLimit\": 100,\n \"LowerAlertSpendLimit\": null,\n \"UpperAlertSpendLimit\": null,\n \"DataLimitEnabled\": false,\n \"DataLimitWarning\": 0,\n \"DataWarningUnitValue\": 1,\n \"DataLimitLimit\": 0,\n \"DataLimitUnitValue\": 1,\n \"TransferredToTelId\": null,\n \"OldNumberBankId\": null,\n \"EID\": null,\n \"IMSI\": null,\n \"ConnectionId\": \"\",\n \"IsPrimaryConnection\": true,\n \"CliToBeReconnected\": false,\n \"LastUpdated\": \"2024-11-12T16:21:26.6701649+00:00\",\n \"LastUpdatedForJigsaw\": \"2024-11-12T16:21:26.6701649+00:00\"\n },\n \"JobNumber\": null,\n \"MayRequireRerate\": false\n}"}],"_postman_id":"2e156be4-1ba8-4241-a218-76c271feceb6"},{"name":"Insert Mobile CLI","id":"81cf7c8d-c938-42b0-a927-4b2adb521fcf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access-token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"customerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"{\r\n \"Cli\": \"APIMOBILE001\",\r\n \"BillPlanId\": 1956, \r\n \"NumberDescription\": \"API_MOBILE_001\",\r\n \"CostCentre\": \"000\",\r\n \"ConnectionDate\": \"2024-11-01T00:00:00Z\",\r\n \"EmailAddress\": \"apimobiletest@informbilling.co.uk\",\r\n \"EquipmentId\": null,\r\n \"EquipmentSerialNo\": null,\r\n \"AddressDetailsAccountNumber\": null,\r\n \"AddressDetailsAccountName\": null,\r\n \"AddressDetailsAddress\": null,\r\n \"AddressDetailsPostcode\": null,\r\n \"AddressDetailsWholesaleOrderNo\": null, \r\n \"SIM\": \"SIM-001\",\r\n \"PUK\": \"PUK-001\", \r\n \"MailboxNumber\": null,\r\n \"DataNumber\": null,\r\n \"FaxNumber\": null,\r\n \"CarrierContractStartDate\": \"2024-01-01T00:00:00\",\r\n \"CarrierContractLength\": 6,\r\n \"CarrierContractTypeId\": 8,\r\n \"UserContractStartDate\": \"2024-02-01T00:00:00\",\r\n \"UserContractLength\": 12,\r\n \"UserContractTypeId\": 9,\r\n \"PAC\": \"PAC-001\",\r\n \"ShortCode\": \"ShortCode-001\",\r\n \"UserDefinedField\":{\r\n \"Custom1\": null,\r\n \"Custom2\": null,\r\n \"Custom3\": null,\r\n \"Custom4\": null,\r\n \"Custom5\": null,\r\n \"Custom6\": null,\r\n \"Custom7\": null,\r\n \"Custom8\": null,\r\n \"Custom9\": \"Twst1\",\r\n \"Custom10\": null,\r\n \"Custom11\": null,\r\n \"Custom12\": null,\r\n \"Custom13\": null,\r\n \"Custom14\": null,\r\n \"Custom15\": null\r\n },\r\n \"PrintSummary\": false,\r\n \"PrintAnalysis\": false,\r\n \"PrintItemisation\": false,\r\n \"EmailSummaryToAccount\": true,\r\n \"EmailAnalysisToAccount\": false,\r\n \"EmailItemisationToAccount\": false,\r\n \"EmailSummaryToBillPlan\": false,\r\n \"EmailAnalysisToBillPlan\": false,\r\n \"EmailItemisationToBillPlan\": false,\r\n \"EmailSummaryToCLI\": false,\r\n \"EmailAnalysisToCLI\": false,\r\n \"EmailItemisationToCLI\": false,\r\n \"AnalysisStyleId\": 1,\r\n \"ShowSavingOnSummary\": false,\r\n \"Creator\": \"admin\",\r\n \"EmailCDRsToAccount\": false,\r\n \"EmailCDRsToBillPlan\": false,\r\n \"EmailCDRsToCLI\": false,\r\n \"DealerId\": null, \r\n \"EID\": null,\r\n \"IMSI\": null,\r\n \"ConnectionId\": null,\r\n \"IsPrimaryConnection\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"{{mainUrl}}v1/CLI/InsertCliMobile","description":"Inserts a Mobile Cli Type Cli.
\nBelow is a list of mandatory fields:
\n","urlObject":{"path":["CLI","InsertCliMobile"],"host":["{{mainUrl}}v1"],"query":[],"variable":[]}},"response":[{"id":"923b72f3-f051-4b00-9b1d-1106cc93b022","name":"Insert Mobile CLI","originalRequest":{"method":"POST","header":[{"key":"customerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"{\r\n \"Cli\": \"APIMOBILE001\",\r\n \"BillPlanId\": 1956, \r\n \"NumberDescription\": \"API_MOBILE_001\",\r\n \"CostCentre\": \"000\",\r\n \"ConnectionDate\": \"2024-11-01T00:00:00Z\",\r\n \"EmailAddress\": \"apimobiletest@informbilling.co.uk\",\r\n \"EquipmentId\": null,\r\n \"EquipmentSerialNo\": null,\r\n \"AddressDetailsAccountNumber\": null,\r\n \"AddressDetailsAccountName\": null,\r\n \"AddressDetailsAddress\": null,\r\n \"AddressDetailsPostcode\": null,\r\n \"AddressDetailsWholesaleOrderNo\": null, \r\n \"SIM\": \"SIM-001\",\r\n \"PUK\": \"PUK-001\", \r\n \"MailboxNumber\": null,\r\n \"DataNumber\": null,\r\n \"FaxNumber\": null,\r\n \"CarrierContractStartDate\": \"2024-01-01T00:00:00\",\r\n \"CarrierContractLength\": 6,\r\n \"CarrierContractTypeId\": 8,\r\n \"UserContractStartDate\": \"2024-02-01T00:00:00\",\r\n \"UserContractLength\": 12,\r\n \"UserContractTypeId\": 9,\r\n \"PAC\": \"PAC-001\",\r\n \"ShortCode\": \"ShortCode-001\",\r\n \"UserDefinedField\":{\r\n \"Custom1\": null,\r\n \"Custom2\": null,\r\n \"Custom3\": null,\r\n \"Custom4\": null,\r\n \"Custom5\": null,\r\n \"Custom6\": null,\r\n \"Custom7\": null,\r\n \"Custom8\": null,\r\n \"Custom9\": \"Custom 9\",\r\n \"Custom10\": null,\r\n \"Custom11\": null,\r\n \"Custom12\": null,\r\n \"Custom13\": null,\r\n \"Custom14\": null,\r\n \"Custom15\": null\r\n },\r\n \"PrintSummary\": false,\r\n \"PrintAnalysis\": false,\r\n \"PrintItemisation\": false,\r\n \"EmailSummaryToAccount\": true,\r\n \"EmailAnalysisToAccount\": false,\r\n \"EmailItemisationToAccount\": false,\r\n \"EmailSummaryToBillPlan\": false,\r\n \"EmailAnalysisToBillPlan\": false,\r\n \"EmailItemisationToBillPlan\": false,\r\n \"EmailSummaryToCLI\": false,\r\n \"EmailAnalysisToCLI\": false,\r\n \"EmailItemisationToCLI\": false,\r\n \"AnalysisStyle\": 1,\r\n \"ShowSavingOnSummary\": false,\r\n \"Creator\": \"admin\",\r\n \"EmailCDRsToAccount\": false,\r\n \"EmailCDRsToBillPlan\": false,\r\n \"EmailCDRsToCLI\": false,\r\n \"DealerId\": null, \r\n \"EID\": null,\r\n \"IMSI\": null,\r\n \"ConnectionId\": null,\r\n \"IsPrimaryConnection\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"{{mainUrl}}v1/CLI/InsertCliMobile"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnModel\": {\n \"CliId\": 30014,\n \"Cli\": \"APIMOBILE001\",\n \"BillPlan\": {\n \"Id\": 1956,\n \"Name\": \"Test Company Ltd\"\n },\n \"CustomerAccount\": {\n \"Id\": 2,\n \"AccountNumber\": \"INTELL01\",\n \"Name\": \"Test Company Ltd\"\n },\n \"BillingCompany\": {\n \"Id\": 4,\n \"Name\": \"Test Company Ltd\"\n },\n \"NumberDescription\": \"API_MOBILE_001\",\n \"CostCentre\": \"000\",\n \"CliType\": {\n \"Id\": 3,\n \"Description\": \"Mobile\"\n },\n \"ConnectionDate\": \"2024-11-01T00:00:00Z\",\n \"DisconnectionDate\": null,\n \"EmailAddress\": \"apimobiletest@informbilling.co.uk\",\n \"EquipmentType\": null,\n \"EquipmentSerialNo\": null,\n \"NumberOfLines\": 0,\n \"NumberOfChannels\": 0,\n \"AddressDetailsAccountNumber\": null,\n \"AddressDetailsAccountName\": null,\n \"AddressDetailsAddress\": null,\n \"AddressDetailsPostcode\": null,\n \"AddressDetailsWholesaleOrderNo\": null,\n \"CPSCentrexRef\": null,\n \"CPSOrderNumber\": null,\n \"CPSOptionId\": null,\n \"SIM\": \"SIM-001\",\n \"PUK\": \"PUK-001\",\n \"MailboxNumber\": null,\n \"DataNumber\": null,\n \"FaxNumber\": null,\n \"RestrictedNumbers\": null,\n \"CarrierContractStartDate\": \"2024-01-01T00:00:00Z\",\n \"CarrierContractEndDate\": \"2024-07-01T00:00:00Z\",\n \"CarrierContractLength\": 6,\n \"CarrierContractContractType\": {\n \"Id\": 8,\n \"ContractType\": \"Upgrade/Renewal\",\n \"CliType\": {\n \"Id\": 3,\n \"Description\": \"Mobile\"\n }\n },\n \"UserContractStartDate\": \"2024-02-01T00:00:00Z\",\n \"UserContractEndDate\": \"2025-02-01T00:00:00Z\",\n \"UserContractLength\": 12,\n \"UserContractContractType\": {\n \"Id\": 9,\n \"ContractType\": \"Account Takeover\",\n \"CliType\": {\n \"Id\": 3,\n \"Description\": \"Mobile\"\n }\n },\n \"PAC\": \"PAC-001\",\n \"ShortCode\": \"ShortCode-001\",\n \"RoutingPlan\": null,\n \"DestP2PNumber\": null,\n \"UserDefinedField\": {\n \"Id\": 30014,\n \"Custom1\": null,\n \"Custom2\": null,\n \"Custom3\": null,\n \"Custom4\": null,\n \"Custom5\": null,\n \"Custom6\": null,\n \"Custom7\": null,\n \"Custom8\": null,\n \"Custom9\": \"Custom 9\",\n \"Custom10\": null,\n \"Custom11\": null,\n \"Custom12\": null,\n \"Custom13\": null,\n \"Custom14\": null,\n \"Custom15\": null\n },\n \"PrintSummary\": false,\n \"PrintAnalysis\": false,\n \"PrintItemisation\": false,\n \"EmailSummaryToAccount\": true,\n \"EmailAnalysisToAccount\": false,\n \"EmailItemisationToAccount\": false,\n \"EmailSummaryToBillPlan\": false,\n \"EmailAnalysisToBillPlan\": false,\n \"EmailItemisationToBillPlan\": false,\n \"EmailSummaryToCLI\": false,\n \"EmailAnalysisToCLI\": false,\n \"EmailItemisationToCLI\": false,\n \"AnalysisStyleId\": 1,\n \"ShowSavingOnSummary\": false,\n \"Creator\": \"admin\",\n \"EmailCDRsToAccount\": false,\n \"EmailCDRsToBillPlan\": false,\n \"EmailCDRsToCLI\": false,\n \"NTSClass\": null,\n \"NTSType\": null,\n \"CreatedDate\": \"2024-11-12T16:43:38.9Z\",\n \"IsDisconnected\": false,\n \"MobileLimitEnabled\": false,\n \"MobileLimitWarning\": null,\n \"MobileLimitLimit\": null,\n \"Dealer\": null,\n \"LowerBundleLimit\": 80,\n \"UpperBundleLimit\": 100,\n \"LowerAlertSpendLimit\": null,\n \"UpperAlertSpendLimit\": null,\n \"DataLimitEnabled\": false,\n \"DataLimitWarning\": 0,\n \"DataWarningUnitValue\": 1,\n \"DataLimitLimit\": 0,\n \"DataLimitUnitValue\": 1,\n \"TransferredToTelId\": null,\n \"OldNumberBankId\": null,\n \"EID\": null,\n \"IMSI\": null,\n \"ConnectionId\": null,\n \"IsPrimaryConnection\": true,\n \"CliToBeReconnected\": false,\n \"LastUpdated\": \"2024-11-12T16:43:38.998796+00:00\",\n \"LastUpdatedForJigsaw\": \"2024-11-12T16:43:38.998796+00:00\"\n },\n \"JobNumber\": null,\n \"MayRequireRerate\": false\n}"}],"_postman_id":"81cf7c8d-c938-42b0-a927-4b2adb521fcf"},{"name":"Insert NTS CLI","id":"0a2c4809-e677-4da7-b46c-e1e17813e1ec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access-token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"customerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"{\r\n \"Cli\": \"APINTS001\",\r\n \"BillPlanId\": 1967, \r\n \"NumberDescription\": \"API_NTS_001\",\r\n \"CostCentre\": \"000\",\r\n \"NumberTypeId\": 2,\r\n \"ConnectionDate\": \"2024-11-01T00:00:00Z\",\r\n \"EmailAddress\": \"apiNTStest@informbilling.co.uk\",\r\n \"EquipmentId\": null,\r\n \"EquipmentSerialNo\": null,\r\n \"AddressDetailsAccountNumber\": null,\r\n \"AddressDetailsAccountName\": null,\r\n \"AddressDetailsAddress\": null,\r\n \"AddressDetailsPostcode\": null,\r\n \"AddressDetailsWholesaleOrderNo\": null, \r\n \"MailboxNumber\": null,\r\n \"DataNumber\": null,\r\n \"FaxNumber\": null,\r\n \"CarrierContractStartDate\": \"2024-01-01T00:00:00\",\r\n \"CarrierContractLength\": 12,\r\n \"CarrierContractTypeId\": 12,\r\n \"UserContractStartDate\": \"2024-02-01T00:00:00\",\r\n \"UserContractLength\": 9,\r\n \"UserContractTypeId\": 13,\r\n \"RoutingPlanId\": 1,\r\n \"DestP2PNumber\": \"NTSP2PNumber\",\r\n \"UserDefinedField\":{\r\n \"Custom1\": null,\r\n \"Custom2\": null,\r\n \"Custom3\": null,\r\n \"Custom4\": null,\r\n \"Custom5\": null,\r\n \"Custom6\": null,\r\n \"Custom7\": null,\r\n \"Custom8\": null,\r\n \"Custom9\": \"Twst1\",\r\n \"Custom10\": null,\r\n \"Custom11\": null,\r\n \"Custom12\": null,\r\n \"Custom13\": null,\r\n \"Custom14\": null,\r\n \"Custom15\": null\r\n },\r\n \"PrintSummary\": false,\r\n \"PrintAnalysis\": false,\r\n \"PrintItemisation\": false,\r\n \"EmailSummaryToAccount\": true,\r\n \"EmailAnalysisToAccount\": false,\r\n \"EmailItemisationToAccount\": false,\r\n \"EmailSummaryToBillPlan\": false,\r\n \"EmailAnalysisToBillPlan\": false,\r\n \"EmailItemisationToBillPlan\": false,\r\n \"EmailSummaryToCLI\": false,\r\n \"EmailAnalysisToCLI\": false,\r\n \"EmailItemisationToCLI\": false,\r\n \"AnalysisStyleId\": 1,\r\n \"ShowSavingOnSummary\": false,\r\n \"Creator\": \"admin\",\r\n \"EmailCDRsToAccount\": false,\r\n \"EmailCDRsToBillPlan\": false,\r\n \"EmailCDRsToCLI\": false,\r\n \"NTSClassValue\": 2,\r\n \"NTSTypeId\": 1,\r\n \"DealerId\": null, \r\n \"EID\": null,\r\n \"IMSI\": null,\r\n \"ConnectionId\": \"\",\r\n \"IsPrimaryConnection\": true\r\n} ","options":{"raw":{"language":"json"}}},"url":"{{mainUrl}}v1/CLI/InsertCliNTS","description":"Inserts an NTS Cli Type Cli.
\nBelow is a list of mandatory fields:
\n","urlObject":{"path":["CLI","InsertCliNTS"],"host":["{{mainUrl}}v1"],"query":[],"variable":[]}},"response":[{"id":"7ea632ca-165c-4e3f-905c-a3434099695e","name":"Insert NTS CLI","originalRequest":{"method":"POST","header":[{"key":"customerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"{\r\n \"Cli\": \"APINTS001\",\r\n \"BillPlanId\": 1967, \r\n \"NumberDescription\": \"API_NTS_001\",\r\n \"CostCentre\": \"000\",\r\n \"NumberTypeId\": 2,\r\n \"ConnectionDate\": \"2024-11-01T00:00:00Z\",\r\n \"EmailAddress\": \"apiNTStest@informbilling.co.uk\",\r\n \"EquipmentId\": null,\r\n \"EquipmentSerialNo\": null,\r\n \"AddressDetailsAccountNumber\": null,\r\n \"AddressDetailsAccountName\": null,\r\n \"AddressDetailsAddress\": null,\r\n \"AddressDetailsPostcode\": null,\r\n \"AddressDetailsWholesaleOrderNo\": null, \r\n \"MailboxNumber\": null,\r\n \"DataNumber\": null,\r\n \"FaxNumber\": null,\r\n \"CarrierContractStartDate\": \"2024-01-01T00:00:00\",\r\n \"CarrierContractLength\": 12,\r\n \"CarrierContractTypeId\": 12,\r\n \"UserContractStartDate\": \"2024-02-01T00:00:00\",\r\n \"UserContractLength\": 9,\r\n \"UserContractTypeId\": 13,\r\n \"RoutingPlanId\": 1,\r\n \"DestP2PNumber\": \"NTSP2PNumber\",\r\n \"UserDefinedField\":{\r\n \"Custom1\": null,\r\n \"Custom2\": null,\r\n \"Custom3\": null,\r\n \"Custom4\": null,\r\n \"Custom5\": null,\r\n \"Custom6\": null,\r\n \"Custom7\": null,\r\n \"Custom8\": null,\r\n \"Custom9\": \"Twst1\",\r\n \"Custom10\": null,\r\n \"Custom11\": null,\r\n \"Custom12\": null,\r\n \"Custom13\": null,\r\n \"Custom14\": null,\r\n \"Custom15\": null\r\n },\r\n \"PrintSummary\": false,\r\n \"PrintAnalysis\": false,\r\n \"PrintItemisation\": false,\r\n \"EmailSummaryToAccount\": true,\r\n \"EmailAnalysisToAccount\": false,\r\n \"EmailItemisationToAccount\": false,\r\n \"EmailSummaryToBillPlan\": false,\r\n \"EmailAnalysisToBillPlan\": false,\r\n \"EmailItemisationToBillPlan\": false,\r\n \"EmailSummaryToCLI\": false,\r\n \"EmailAnalysisToCLI\": false,\r\n \"EmailItemisationToCLI\": false,\r\n \"AnalysisStyleId\": 1,\r\n \"ShowSavingOnSummary\": false,\r\n \"Creator\": \"admin\",\r\n \"EmailCDRsToAccount\": false,\r\n \"EmailCDRsToBillPlan\": false,\r\n \"EmailCDRsToCLI\": false,\r\n \"NTSClassValue\": 2,\r\n \"NTSTypeId\": 1,\r\n \"DealerId\": null, \r\n \"EID\": null,\r\n \"IMSI\": null,\r\n \"ConnectionId\": \"\",\r\n \"IsPrimaryConnection\": true\r\n} ","options":{"raw":{"language":"json"}}},"url":"{{mainUrl}}v1/CLI/InsertCliNTS"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnModel\": {\n \"CliId\": 30013,\n \"Cli\": \"APINTS001\",\n \"BillPlan\": {\n \"Id\": 1967,\n \"Name\": \"EE Glass Ltd\"\n },\n \"CustomerAccount\": {\n \"Id\": 7,\n \"AccountNumber\": \"EEGLASS1\",\n \"Name\": \"EE Glass Ltd\"\n },\n \"BillingCompany\": {\n \"Id\": 4,\n \"Name\": \"Digi Toolbox Ltd\"\n },\n \"NumberDescription\": \"API_NTS_001\",\n \"CostCentre\": \"000\",\n \"CliType\": {\n \"Id\": 2,\n \"Description\": \"Inbound NTS\"\n },\n \"ConnectionDate\": \"2024-11-01T00:00:00Z\",\n \"DisconnectionDate\": null,\n \"EmailAddress\": \"apiNTStest@informbilling.co.uk\",\n \"EquipmentType\": null,\n \"EquipmentSerialNo\": null,\n \"NumberOfLines\": 0,\n \"NumberOfChannels\": 0,\n \"AddressDetailsAccountNumber\": null,\n \"AddressDetailsAccountName\": null,\n \"AddressDetailsAddress\": null,\n \"AddressDetailsPostcode\": null,\n \"AddressDetailsWholesaleOrderNo\": null,\n \"CPSCentrexRef\": null,\n \"CPSOrderNumber\": null,\n \"CPSOptionId\": null,\n \"SIM\": null,\n \"PUK\": null,\n \"MailboxNumber\": null,\n \"DataNumber\": null,\n \"FaxNumber\": null,\n \"RestrictedNumbers\": null,\n \"CarrierContractStartDate\": \"2024-01-01T00:00:00Z\",\n \"CarrierContractEndDate\": \"2025-01-01T00:00:00Z\",\n \"CarrierContractLength\": 12,\n \"CarrierContractContractType\": {\n \"Id\": 12,\n \"ContractType\": \"Contract Re-Sign\",\n \"CliType\": {\n \"Id\": 2,\n \"Description\": \"Inbound NTS\"\n }\n },\n \"UserContractStartDate\": \"2024-02-01T00:00:00Z\",\n \"UserContractEndDate\": \"2024-11-01T00:00:00Z\",\n \"UserContractLength\": 9,\n \"UserContractContractType\": {\n \"Id\": 13,\n \"ContractType\": \"Account Takeover\",\n \"CliType\": {\n \"Id\": 2,\n \"Description\": \"Inbound NTS\"\n }\n },\n \"PAC\": null,\n \"ShortCode\": null,\n \"RoutingPlan\": {\n \"Id\": 1,\n \"Description\": \"Simple Point-to-Point\"\n },\n \"DestP2PNumber\": \"NTSP2PNumber\",\n \"UserDefinedField\": {\n \"Id\": 30013,\n \"Custom1\": null,\n \"Custom2\": null,\n \"Custom3\": null,\n \"Custom4\": null,\n \"Custom5\": null,\n \"Custom6\": null,\n \"Custom7\": null,\n \"Custom8\": null,\n \"Custom9\": \"Twst1\",\n \"Custom10\": null,\n \"Custom11\": null,\n \"Custom12\": null,\n \"Custom13\": null,\n \"Custom14\": null,\n \"Custom15\": null\n },\n \"PrintSummary\": false,\n \"PrintAnalysis\": false,\n \"PrintItemisation\": false,\n \"EmailSummaryToAccount\": true,\n \"EmailAnalysisToAccount\": false,\n \"EmailItemisationToAccount\": false,\n \"EmailSummaryToBillPlan\": false,\n \"EmailAnalysisToBillPlan\": false,\n \"EmailItemisationToBillPlan\": false,\n \"EmailSummaryToCLI\": false,\n \"EmailAnalysisToCLI\": false,\n \"EmailItemisationToCLI\": false,\n \"AnalysisStyleId\": 1,\n \"ShowSavingOnSummary\": false,\n \"Creator\": \"admin\",\n \"EmailCDRsToAccount\": false,\n \"EmailCDRsToBillPlan\": false,\n \"EmailCDRsToCLI\": false,\n \"NTSClass\": {\n \"Id\": 1,\n \"Description\": \"Standard\"\n },\n \"NTSType\": {\n \"Id\": 1,\n \"Description\": \"Inbound NTS 0800/0808 Freephone\"\n },\n \"CreatedDate\": \"2024-11-12T16:32:21.97Z\",\n \"IsDisconnected\": false,\n \"MobileLimitEnabled\": false,\n \"MobileLimitWarning\": null,\n \"MobileLimitLimit\": null,\n \"Dealer\": null,\n \"LowerBundleLimit\": 80,\n \"UpperBundleLimit\": 100,\n \"LowerAlertSpendLimit\": null,\n \"UpperAlertSpendLimit\": null,\n \"DataLimitEnabled\": false,\n \"DataLimitWarning\": 0,\n \"DataWarningUnitValue\": 1,\n \"DataLimitLimit\": 0,\n \"DataLimitUnitValue\": 1,\n \"TransferredToTelId\": null,\n \"OldNumberBankId\": null,\n \"EID\": null,\n \"IMSI\": null,\n \"ConnectionId\": \"\",\n \"IsPrimaryConnection\": true,\n \"CliToBeReconnected\": false,\n \"LastUpdated\": \"2024-11-12T16:32:22.0254874+00:00\",\n \"LastUpdatedForJigsaw\": \"2024-11-12T16:32:22.0254874+00:00\"\n },\n \"JobNumber\": null,\n \"MayRequireRerate\": false\n}"}],"_postman_id":"0a2c4809-e677-4da7-b46c-e1e17813e1ec"},{"name":"Update CLI Fixed","id":"4ceb910d-f32a-4d23-be67-85798192263d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access-token}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"customerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"{\r\n \"CliId\": 30012,\r\n \"Cli\": \"APIFixed001\", \r\n \"NumberDescription\": \"API_Fixed_001-Amended\",\r\n \"CostCentre\": \"000\",\r\n \"ConnectionDate\": \"2024-01-01T00:00:00Z\",\r\n \"EmailAddress\": \"apifixedtest@informbilling.co.uk\",\r\n \"EquipmentId\": null,\r\n \"EquipmentSerialNo\": null,\r\n \"AddressDetailsAccountNumber\": null,\r\n \"AddressDetailsAccountName\": null,\r\n \"AddressDetailsAddress\": null,\r\n \"AddressDetailsPostcode\": null,\r\n \"AddressDetailsWholesaleOrderNo\": null,\r\n \"MailboxNumber\": null,\r\n \"DataNumber\": null,\r\n \"FaxNumber\": null, \r\n \"CarrierContractStartDate\": \"2024-01-01T00:00:00Z\",\r\n\t\"CarrierContractEndDate\": \"2025-01-01T00:00:00Z\",\r\n\t\"CarrierContractLength\": 12,\r\n\t\"CarrierContractContractTypeId\": 1,\r\n\t\"UserContractStartDate\": \"2024-01-01T00:00:00Z\",\r\n\t\"UserContractEndDate\": \"2025-01-01T00:00:00Z\",\r\n\t\"UserContractLength\": 12,\r\n\t\"UserContractContractTypeId\": 2,\r\n \"DealerId\": null, \r\n \"EID\": null,\r\n \"IMSI\": null,\r\n \"ConnectionId\": \"\",\r\n \"IsPrimaryConnection\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"{{mainUrl}}v1/CLI/UpdateCliFixed","description":"Update a fixed Cli.
\nBelow is a list of mandatory fields:
\n","urlObject":{"path":["CLI","UpdateCliFixed"],"host":["{{mainUrl}}v1"],"query":[],"variable":[]}},"response":[{"id":"2e0ddd4b-bed6-4121-97d7-0d910fe2430c","name":"Update CLI Fixed","originalRequest":{"method":"PUT","header":[{"key":"customerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"{\r\n \"CliId\": 30012,\r\n \"Cli\": \"APIFixed001\", \r\n \"NumberDescription\": \"API_Fixed_001-Amended\",\r\n \"CostCentre\": \"000\",\r\n \"ConnectionDate\": \"2024-01-01T00:00:00Z\",\r\n \"EmailAddress\": \"apifixedtest@informbilling.co.uk\",\r\n \"EquipmentId\": null,\r\n \"EquipmentSerialNo\": null,\r\n \"AddressDetailsAccountNumber\": null,\r\n \"AddressDetailsAccountName\": null,\r\n \"AddressDetailsAddress\": null,\r\n \"AddressDetailsPostcode\": null,\r\n \"AddressDetailsWholesaleOrderNo\": null,\r\n \"MailboxNumber\": null,\r\n \"DataNumber\": null,\r\n \"FaxNumber\": null, \r\n \"CarrierContractStartDate\": \"2024-01-01T00:00:00Z\",\r\n\t\"CarrierContractEndDate\": \"2025-01-01T00:00:00Z\",\r\n\t\"CarrierContractLength\": 12,\r\n\t\"CarrierContractContractTypeId\": 1,\r\n\t\"UserContractStartDate\": \"2024-01-01T00:00:00Z\",\r\n\t\"UserContractEndDate\": \"2025-01-01T00:00:00Z\",\r\n\t\"UserContractLength\": 12,\r\n\t\"UserContractContractTypeId\": 2,\r\n \"DealerId\": null, \r\n \"EID\": null,\r\n \"IMSI\": null,\r\n \"ConnectionId\": \"\",\r\n \"IsPrimaryConnection\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"{{mainUrl}}v1/CLI/UpdateCliFixed"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"ReturnModel\": {\r\n \"CliId\": 30012,\r\n \"Cli\": \"APIFixed001\",\r\n \"BillPlan\": {\r\n \"Id\": 1963,\r\n \"Name\": \"Test Company Ltd\"\r\n },\r\n \"CustomerAccount\": {\r\n \"Id\": 5,\r\n \"AccountNumber\": \"DIGI0001\",\r\n \"Name\": \"Test Company Ltd\"\r\n },\r\n \"BillingCompany\": {\r\n \"Id\": 4,\r\n \"Name\": \"Test Company Ltd\"\r\n },\r\n \"NumberDescription\": \"API_Fixed_001-Amended\",\r\n \"CostCentre\": \"000\",\r\n \"CliType\": {\r\n \"Id\": 1,\r\n \"Description\": \"Fixed\"\r\n },\r\n \"ConnectionDate\": \"2024-01-01T00:00:00Z\",\r\n \"DisconnectionDate\": null,\r\n \"EmailAddress\": \"apifixedtest@informbilling.co.uk\",\r\n \"EquipmentType\": null,\r\n \"EquipmentSerialNo\": null,\r\n \"NumberOfLines\": 0,\r\n \"NumberOfChannels\": 0,\r\n \"AddressDetailsAccountNumber\": null,\r\n \"AddressDetailsAccountName\": null,\r\n \"AddressDetailsAddress\": null,\r\n \"AddressDetailsPostcode\": null,\r\n \"AddressDetailsWholesaleOrderNo\": null,\r\n \"CPSCentrexRef\": null,\r\n \"CPSOrderNumber\": null,\r\n \"CPSOptionId\": null,\r\n \"SIM\": null,\r\n \"PUK\": null,\r\n \"MailboxNumber\": null,\r\n \"DataNumber\": null,\r\n \"FaxNumber\": null,\r\n \"RestrictedNumbers\": null,\r\n \"CarrierContractStartDate\": \"2024-01-01T00:00:00Z\",\r\n \"CarrierContractEndDate\": \"2025-01-01T00:00:00Z\",\r\n \"CarrierContractLength\": 12,\r\n \"CarrierContractType\": {\r\n \"Id\": 1,\r\n \"ContractType\": \"New Number\",\r\n \"CliType\": {\r\n \"Id\": 1,\r\n \"Description\": \"Fixed\"\r\n }\r\n },\r\n \"UserContractStartDate\": \"2024-01-01T00:00:00Z\",\r\n \"UserContractEndDate\": \"2025-01-01T00:00:00Z\",\r\n \"UserContractLength\": 12,\r\n \"UserContractType\": {\r\n \"Id\": 2,\r\n \"ContractType\": \"Migration (Line Takeover)\",\r\n \"CliType\": {\r\n \"Id\": 1,\r\n \"Description\": \"Fixed\"\r\n }\r\n },\r\n \"PAC\": null,\r\n \"ShortCode\": null,\r\n \"RoutingPlan\": null,\r\n \"DestP2PNumber\": null,\r\n \"UserDefinedField\": {\r\n \"Id\": 30012,\r\n \"Custom1\": null,\r\n \"Custom2\": null,\r\n \"Custom3\": null,\r\n \"Custom4\": null,\r\n \"Custom5\": null,\r\n \"Custom6\": null,\r\n \"Custom7\": null,\r\n \"Custom8\": null,\r\n \"Custom9\": \"Custom 9\",\r\n \"Custom10\": null,\r\n \"Custom11\": null,\r\n \"Custom12\": null,\r\n \"Custom13\": null,\r\n \"Custom14\": null,\r\n \"Custom15\": null\r\n },\r\n \"PrintSummary\": false,\r\n \"PrintAnalysis\": false,\r\n \"PrintItemisation\": false,\r\n \"EmailSummaryToAccount\": true,\r\n \"EmailAnalysisToAccount\": false,\r\n \"EmailItemisationToAccount\": false,\r\n \"EmailSummaryToBillPlan\": false,\r\n \"EmailAnalysisToBillPlan\": false,\r\n \"EmailItemisationToBillPlan\": false,\r\n \"EmailSummaryToCLI\": false,\r\n \"EmailAnalysisToCLI\": false,\r\n \"EmailItemisationToCLI\": false,\r\n \"AnalysisStyleId\": 1,\r\n \"ShowSavingOnSummary\": false,\r\n \"Creator\": \"admin\",\r\n \"EmailCDRsToAccount\": false,\r\n \"EmailCDRsToBillPlan\": false,\r\n \"EmailCDRsToCLI\": false,\r\n \"NTSClass\": null,\r\n \"NTSType\": null,\r\n \"CreatedDate\": \"2024-11-12T16:21:26.5Z\",\r\n \"IsDisconnected\": false,\r\n \"MobileLimitEnabled\": false,\r\n \"MobileLimitWarning\": null,\r\n \"MobileLimitLimit\": null,\r\n \"Dealer\": null,\r\n \"LowerBundleLimit\": 80,\r\n \"UpperBundleLimit\": 100,\r\n \"LowerAlertSpendLimit\": null,\r\n \"UpperAlertSpendLimit\": null,\r\n \"DataLimitEnabled\": false,\r\n \"DataLimitWarning\": 0,\r\n \"DataWarningUnitValue\": 1,\r\n \"DataLimitLimit\": 0,\r\n \"DataLimitUnitValue\": 1,\r\n \"TransferredToTelId\": null,\r\n \"OldNumberBankId\": null,\r\n \"EID\": null,\r\n \"IMSI\": null,\r\n \"ConnectionId\": \"\",\r\n \"IsPrimaryConnection\": true,\r\n \"CliToBeReconnected\": false,\r\n \"LastUpdated\": \"2024-11-13T11:39:29.2566435+00:00\",\r\n \"LastUpdatedForJigsaw\": \"2024-11-12T16:21:26.6701649+00:00\"\r\n },\r\n \"JobNumber\": null,\r\n \"MayRequireRerate\": true\r\n}"}],"_postman_id":"4ceb910d-f32a-4d23-be67-85798192263d"},{"name":"Update CLI Mobile","id":"11de51b1-6a2f-48d2-a518-528c4936cae8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access-token}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"customerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"{\r\n \"CliId\": 30014,\r\n \"Cli\": \"APIMOBILE001\", \r\n \"NumberDescription\": \"API_MOBILE_001_Amended\",\r\n \"SIM\": \"SIM-001_Amended\",\r\n \"PUK\": \"PUK-001_Amended\",\r\n \"PAC\": \"PAC-001_Amended\",\r\n \"ShortCode\": \"ShortCode-001_Amended\",\r\n \"CostCentre\": \"000\",\r\n \"ConnectionDate\": \"2022-10-01T00:00:00Z\",\r\n \"EmailAddress\": \"apimobiletest@informbilling.co.uk\",\r\n \"EquipmentId\": null,\r\n \"EquipmentSerialNo\": null, \r\n \"MailboxNumber\": null,\r\n \"DataNumber\": null,\r\n \"FaxNumber\": null, \r\n \"CarrierContractStartDate\": \"2024-01-01T00:00:00\",\r\n \"CarrierContractLength\": 8,\r\n \"CarrierContractTypeId\": 5,\r\n \"UserContractStartDate\": \"2024-02-01T00:00:00\",\r\n \"UserContractLength\": 13,\r\n \"UserContractTypeId\": 6, \r\n \"DealerId\": null, \r\n \"EID\": null,\r\n \"IMSI\": null,\r\n \"ConnectionId\": \"\",\r\n \"IsPrimaryConnection\": true\r\n} \r\n","options":{"raw":{"language":"json"}}},"url":"{{mainUrl}}v1/CLI/UpdateCliMobile","description":"Update a Mobile Cli.
\nBelow is a list of mandatory fields:
\n","urlObject":{"path":["CLI","UpdateCliMobile"],"host":["{{mainUrl}}v1"],"query":[],"variable":[]}},"response":[{"id":"67ca9942-490b-48fc-aa20-19c2360498ab","name":"Update CLI Mobile","originalRequest":{"method":"PUT","header":[{"key":"customerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"{\r\n \"CliId\": 30014,\r\n \"Cli\": \"APIMOBILE001\", \r\n \"NumberDescription\": \"API_MOBILE_001_Amended\",\r\n \"SIM\": \"SIM-001_Amended\",\r\n \"PUK\": \"PUK-001_Amended\",\r\n \"PAC\": \"PAC-001_Amended\",\r\n \"ShortCode\": \"ShortCode-001_Amended\",\r\n \"CostCentre\": \"000\",\r\n \"ConnectionDate\": \"2022-10-01T00:00:00Z\",\r\n \"EmailAddress\": \"apimobiletest@informbilling.co.uk\",\r\n \"EquipmentId\": null,\r\n \"EquipmentSerialNo\": \"Test SerialNo_Amended\", \r\n \"MailboxNumber\": null,\r\n \"DataNumber\": null,\r\n \"FaxNumber\": null, \r\n \"CarrierContractStartDate\": \"2024-01-01T00:00:00\",\r\n \"CarrierContractLength\": 8,\r\n \"CarrierContractTypeId\": 5,\r\n \"UserContractStartDate\": \"2024-02-01T00:00:00\",\r\n \"UserContractLength\": 13,\r\n \"UserContractTypeId\": 6, \r\n \"DealerId\": null, \r\n \"EID\": null,\r\n \"IMSI\": null,\r\n \"ConnectionId\": \"\",\r\n \"IsPrimaryConnection\": true\r\n} \r\n","options":{"raw":{"language":"json"}}},"url":"{{mainUrl}}v1/CLI/UpdateCliMobile"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"ReturnModel\": {\r\n \"CliId\": 30014,\r\n \"Cli\": \"APIMOBILE001\",\r\n \"BillPlan\": {\r\n \"Id\": 1956,\r\n \"Name\": \"Test Company Ltd\"\r\n },\r\n \"CustomerAccount\": {\r\n \"Id\": 2,\r\n \"AccountNumber\": \"INTELL01\",\r\n \"Name\": \"Test Company Ltd\"\r\n },\r\n \"BillingCompany\": {\r\n \"Id\": 4,\r\n \"Name\": \"Test Company Ltd\"\r\n },\r\n \"NumberDescription\": \"API_MOBILE_001_Amended\",\r\n \"CostCentre\": \"000\",\r\n \"CliType\": {\r\n \"Id\": 3,\r\n \"Description\": \"Mobile\"\r\n },\r\n \"ConnectionDate\": \"2022-10-01T00:00:00Z\",\r\n \"DisconnectionDate\": null,\r\n \"EmailAddress\": \"apimobiletest@informbilling.co.uk\",\r\n \"EquipmentType\": null,\r\n \"EquipmentSerialNo\": null,\r\n \"NumberOfLines\": 0,\r\n \"NumberOfChannels\": 0,\r\n \"AddressDetailsAccountNumber\": null,\r\n \"AddressDetailsAccountName\": null,\r\n \"AddressDetailsAddress\": null,\r\n \"AddressDetailsPostcode\": null,\r\n \"AddressDetailsWholesaleOrderNo\": null,\r\n \"CPSCentrexRef\": null,\r\n \"CPSOrderNumber\": null,\r\n \"CPSOptionId\": null,\r\n \"SIM\": \"SIM-001_Amended\",\r\n \"PUK\": \"PUK-001_Amended\",\r\n \"MailboxNumber\": null,\r\n \"DataNumber\": null,\r\n \"FaxNumber\": null,\r\n \"RestrictedNumbers\": null,\r\n \"CarrierContractStartDate\": \"2024-01-01T00:00:00Z\",\r\n \"CarrierContractEndDate\": \"2024-09-01T00:00:00Z\",\r\n \"CarrierContractLength\": 8,\r\n \"CarrierContractType\": {\r\n \"Id\": 5,\r\n \"ContractType\": \"New Number\",\r\n \"CliType\": {\r\n \"Id\": 3,\r\n \"Description\": \"Mobile\"\r\n }\r\n },\r\n \"UserContractStartDate\": \"2024-02-01T00:00:00Z\",\r\n \"UserContractEndDate\": \"2025-03-01T00:00:00Z\",\r\n \"UserContractLength\": 13,\r\n \"UserContractType\": {\r\n \"Id\": 6,\r\n \"ContractType\": \"Port\",\r\n \"CliType\": {\r\n \"Id\": 3,\r\n \"Description\": \"Mobile\"\r\n }\r\n },\r\n \"PAC\": \"PAC-001_Amended\",\r\n \"ShortCode\": \"ShortCode-001_Amended\",\r\n \"RoutingPlan\": null,\r\n \"DestP2PNumber\": null,\r\n \"UserDefinedField\": {\r\n \"Id\": 30014,\r\n \"Custom1\": null,\r\n \"Custom2\": null,\r\n \"Custom3\": null,\r\n \"Custom4\": null,\r\n \"Custom5\": null,\r\n \"Custom6\": null,\r\n \"Custom7\": null,\r\n \"Custom8\": null,\r\n \"Custom9\": \"Custom 9\",\r\n \"Custom10\": null,\r\n \"Custom11\": null,\r\n \"Custom12\": null,\r\n \"Custom13\": null,\r\n \"Custom14\": null,\r\n \"Custom15\": null\r\n },\r\n \"PrintSummary\": true,\r\n \"PrintAnalysis\": true,\r\n \"PrintItemisation\": true,\r\n \"EmailSummaryToAccount\": true,\r\n \"EmailAnalysisToAccount\": true,\r\n \"EmailItemisationToAccount\": true,\r\n \"EmailSummaryToBillPlan\": true,\r\n \"EmailAnalysisToBillPlan\": false,\r\n \"EmailItemisationToBillPlan\": true,\r\n \"EmailSummaryToCLI\": true,\r\n \"EmailAnalysisToCLI\": true,\r\n \"EmailItemisationToCLI\": true,\r\n \"AnalysisStyleId\": 1,\r\n \"ShowSavingOnSummary\": true,\r\n \"Creator\": \"admin\",\r\n \"EmailCDRsToAccount\": true,\r\n \"EmailCDRsToBillPlan\": true,\r\n \"EmailCDRsToCLI\": true,\r\n \"NTSClass\": null,\r\n \"NTSType\": null,\r\n \"CreatedDate\": \"2024-11-12T16:43:38.9Z\",\r\n \"IsDisconnected\": false,\r\n \"MobileLimitEnabled\": false,\r\n \"MobileLimitWarning\": null,\r\n \"MobileLimitLimit\": null,\r\n \"Dealer\": null,\r\n \"LowerBundleLimit\": 80,\r\n \"UpperBundleLimit\": 100,\r\n \"LowerAlertSpendLimit\": null,\r\n \"UpperAlertSpendLimit\": null,\r\n \"DataLimitEnabled\": false,\r\n \"DataLimitWarning\": 0,\r\n \"DataWarningUnitValue\": 1,\r\n \"DataLimitLimit\": 0,\r\n \"DataLimitUnitValue\": 1,\r\n \"TransferredToTelId\": null,\r\n \"OldNumberBankId\": null,\r\n \"EID\": null,\r\n \"IMSI\": null,\r\n \"ConnectionId\": \"\",\r\n \"IsPrimaryConnection\": true,\r\n \"CliToBeReconnected\": false,\r\n \"LastUpdated\": \"2024-12-06T16:54:44.7519525+00:00\",\r\n \"LastUpdatedForJigsaw\": \"2024-12-06T16:54:42.9651461+00:00\"\r\n },\r\n \"JobNumber\": null,\r\n \"MayRequireRerate\": true\r\n}"}],"_postman_id":"11de51b1-6a2f-48d2-a518-528c4936cae8"},{"name":"Update CLI NTS","id":"59565a72-491c-42bf-afb1-d73172a769ca","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access-token}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"customerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"{\r\n \"CliId\": 30022,\r\n \"Cli\": \"APINTSTest1\", \r\n \"NumberDescription\": \"APINTS_Test_1\",\r\n \"RoutingPlanId\": 1,\r\n \"NTSClassId\": 3,\r\n \"NTSTypeId\": 5,\r\n \"DestP2PNumber\": null,\r\n \"CostCentre\": \"000\",\r\n \"ConnectionDate\": \"2022-10-01T00:00:00Z\",\r\n \"EmailAddress\": \"apintstest@informbilling.co.uk\",\r\n \"EquipmentId\": null,\r\n \"EquipmentSerialNo\": null, \r\n \"MailboxNumber\": null,\r\n \"DataNumber\": null,\r\n \"FaxNumber\": null, \r\n \"CarrierContractStartDate\": \"2022-01-01T00:00:00\",\r\n \"CarrierContractLength\": 6,\r\n \"CarrierContractTypeId\": 11,\r\n \"UserContractStartDate\": \"2021-02-01T00:00:00\",\r\n \"UserContractLength\": 5,\r\n \"UserContractTypeId\": 14, \r\n \"DealerId\": null, \r\n \"EID\": null,\r\n \"IMSI\": null,\r\n \"ConnectionId\": \"\",\r\n \"IsPrimaryConnection\": true\r\n} \r\n","options":{"raw":{"language":"json"}}},"url":"{{mainUrl}}v1/CLI/UpdateCliNTS","description":"Update an NTS Cli.
\nBelow is a list of mandatory fields:
\n","urlObject":{"path":["CLI","UpdateCliNTS"],"host":["{{mainUrl}}v1"],"query":[],"variable":[]}},"response":[{"id":"c4b27210-ccc5-40a7-8a1b-659194577128","name":"Update CLI NTS","originalRequest":{"method":"PUT","header":[{"key":"customerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"{\r\n \"CliId\": 30022,\r\n \"Cli\": \"APINTSTest1\", \r\n \"NumberDescription\": \"APINTS_Test_1_Amended\",\r\n \"RoutingPlanId\": 1,\r\n \"NTSClassId\": 3,\r\n \"NTSTypeId\": 5,\r\n \"DestP2PNumber\": null,\r\n \"CostCentre\": \"000\",\r\n \"ConnectionDate\": \"2022-10-01T00:00:00Z\",\r\n \"EmailAddress\": \"apintstest@informbilling.co.uk\",\r\n \"EquipmentId\": null,\r\n \"EquipmentSerialNo\": null, \r\n \"MailboxNumber\": null,\r\n \"DataNumber\": null,\r\n \"FaxNumber\": null, \r\n \"CarrierContractStartDate\": \"2022-01-01T00:00:00\",\r\n \"CarrierContractLength\": 6,\r\n \"CarrierContractTypeId\": 11,\r\n \"UserContractStartDate\": \"2021-02-01T00:00:00\",\r\n \"UserContractLength\": 5,\r\n \"UserContractTypeId\": 14, \r\n \"DealerId\": null, \r\n \"EID\": null,\r\n \"IMSI\": null,\r\n \"ConnectionId\": \"\",\r\n \"IsPrimaryConnection\": true\r\n} \r\n","options":{"raw":{"language":"json"}}},"url":"{{mainUrl}}v1/CLI/UpdateCliNTS"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"ReturnModel\": {\r\n \"CliId\": 30022,\r\n \"Cli\": \"APINTSTest1\",\r\n \"BillPlan\": {\r\n \"Id\": 1956,\r\n \"Name\": \"Test Company Ltd\"\r\n },\r\n \"CustomerAccount\": {\r\n \"Id\": 2,\r\n \"AccountNumber\": \"INTELL01\",\r\n \"Name\": \"Test Company Ltd\"\r\n },\r\n \"BillingCompany\": {\r\n \"Id\": 4,\r\n \"Name\": \"Test Company Ltd\"\r\n },\r\n \"NumberDescription\": \"APINTS_Test_1_Amended\",\r\n \"CostCentre\": \"000\",\r\n \"CliType\": {\r\n \"Id\": 2,\r\n \"Description\": \"Inbound NTS\"\r\n },\r\n \"ConnectionDate\": \"2022-10-01T00:00:00Z\",\r\n \"DisconnectionDate\": null,\r\n \"EmailAddress\": \"apintstest@informbilling.co.uk\",\r\n \"EquipmentType\": null,\r\n \"EquipmentSerialNo\": null,\r\n \"NumberOfLines\": 0,\r\n \"NumberOfChannels\": 0,\r\n \"AddressDetailsAccountNumber\": null,\r\n \"AddressDetailsAccountName\": null,\r\n \"AddressDetailsAddress\": null,\r\n \"AddressDetailsPostcode\": null,\r\n \"AddressDetailsWholesaleOrderNo\": null,\r\n \"CPSCentrexRef\": null,\r\n \"CPSOrderNumber\": null,\r\n \"CPSOptionId\": null,\r\n \"SIM\": null,\r\n \"PUK\": null,\r\n \"MailboxNumber\": null,\r\n \"DataNumber\": null,\r\n \"FaxNumber\": null,\r\n \"RestrictedNumbers\": null,\r\n \"CarrierContractStartDate\": \"2022-01-01T00:00:00Z\",\r\n \"CarrierContractEndDate\": \"2022-07-01T00:00:00Z\",\r\n \"CarrierContractLength\": 6,\r\n \"CarrierContractType\": {\r\n \"Id\": 11,\r\n \"ContractType\": \"Port\",\r\n \"CliType\": {\r\n \"Id\": 2,\r\n \"Description\": \"Inbound NTS\"\r\n }\r\n },\r\n \"UserContractStartDate\": \"2021-02-01T00:00:00Z\",\r\n \"UserContractEndDate\": \"2021-07-01T00:00:00Z\",\r\n \"UserContractLength\": 5,\r\n \"UserContractType\": {\r\n \"Id\": 14,\r\n \"ContractType\": \"Out of Contract\",\r\n \"CliType\": {\r\n \"Id\": 2,\r\n \"Description\": \"Inbound NTS\"\r\n }\r\n },\r\n \"PAC\": null,\r\n \"ShortCode\": null,\r\n \"RoutingPlan\": {\r\n \"Id\": 1,\r\n \"Description\": \"Simple Point-to-Point\"\r\n },\r\n \"DestP2PNumber\": null,\r\n \"UserDefinedField\": {\r\n \"Id\": 30022,\r\n \"Custom1\": \"\",\r\n \"Custom2\": null,\r\n \"Custom3\": null,\r\n \"Custom4\": null,\r\n \"Custom5\": null,\r\n \"Custom6\": null,\r\n \"Custom7\": null,\r\n \"Custom8\": null,\r\n \"Custom9\": \"Custom 9\",\r\n \"Custom10\": null,\r\n \"Custom11\": null,\r\n \"Custom12\": null,\r\n \"Custom13\": null,\r\n \"Custom14\": null,\r\n \"Custom15\": null\r\n },\r\n \"PrintSummary\": false,\r\n \"PrintAnalysis\": false,\r\n \"PrintItemisation\": false,\r\n \"EmailSummaryToAccount\": true,\r\n \"EmailAnalysisToAccount\": false,\r\n \"EmailItemisationToAccount\": false,\r\n \"EmailSummaryToBillPlan\": false,\r\n \"EmailAnalysisToBillPlan\": false,\r\n \"EmailItemisationToBillPlan\": false,\r\n \"EmailSummaryToCLI\": false,\r\n \"EmailAnalysisToCLI\": false,\r\n \"EmailItemisationToCLI\": false,\r\n \"AnalysisStyleId\": 1,\r\n \"ShowSavingOnSummary\": false,\r\n \"Creator\": \"admin\",\r\n \"EmailCDRsToAccount\": false,\r\n \"EmailCDRsToBillPlan\": false,\r\n \"EmailCDRsToCLI\": false,\r\n \"NTSClass\": {\r\n \"Id\": 3,\r\n \"Description\": \"Silver\"\r\n },\r\n \"NTSType\": {\r\n \"Id\": 5,\r\n \"Description\": \"Inbound NTS 0845/0844 Lo-Call\"\r\n },\r\n \"CreatedDate\": \"2024-12-03T14:27:09.88Z\",\r\n \"IsDisconnected\": false,\r\n \"MobileLimitEnabled\": false,\r\n \"MobileLimitWarning\": null,\r\n \"MobileLimitLimit\": null,\r\n \"Dealer\": null,\r\n \"LowerBundleLimit\": 80,\r\n \"UpperBundleLimit\": 100,\r\n \"LowerAlertSpendLimit\": null,\r\n \"UpperAlertSpendLimit\": null,\r\n \"DataLimitEnabled\": false,\r\n \"DataLimitWarning\": 0,\r\n \"DataWarningUnitValue\": 1,\r\n \"DataLimitLimit\": 0,\r\n \"DataLimitUnitValue\": 1,\r\n \"TransferredToTelId\": null,\r\n \"OldNumberBankId\": null,\r\n \"EID\": null,\r\n \"IMSI\": null,\r\n \"ConnectionId\": \"\",\r\n \"IsPrimaryConnection\": true,\r\n \"CliToBeReconnected\": false,\r\n \"LastUpdated\": \"2024-12-05T17:09:46.4254053+00:00\",\r\n \"LastUpdatedForJigsaw\": \"2024-12-05T17:09:44.7330296+00:00\"\r\n },\r\n \"JobNumber\": null,\r\n \"MayRequireRerate\": true\r\n}"}],"_postman_id":"59565a72-491c-42bf-afb1-d73172a769ca"},{"name":"Update CLI Output Options","id":"76669ba9-4327-4ad5-b2ae-2b92a9e9ee72","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access-token}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"customerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"{\r\n \"CliId\": 30014,\r\n \"PrintSummary\": true,\r\n \"PrintAnalysis\": true,\r\n \"PrintItemisation\": true,\r\n \"EmailSummaryToAccount\": true,\r\n \"EmailAnalysisToAccount\": true,\r\n \"EmailItemisationToAccount\": true,\r\n \"EmailSummaryToBillPlan\": true,\r\n \"EmailAnalysisToBillPlan\": false,\r\n \"EmailItemisationToBillPlan\": true,\r\n \"EmailSummaryToCLI\": true,\r\n \"EmailAnalysisToCLI\": true,\r\n \"EmailItemisationToCLI\": true,\r\n \"AnalysisStyleId\": 1,\r\n \"ShowSavingOnSummary\": true,\r\n \"EmailCDRsToAccount\": true,\r\n \"EmailCDRsToBillPlan\": true,\r\n \"EmailCDRsToCLI\": true\r\n} \r\n","options":{"raw":{"language":"json"}}},"url":"{{mainUrl}}v1/CLI/UpdateCliOutputOptions","description":"Update Cli Output Options.
\nBelow is a list of mandatory fields:
\n","urlObject":{"path":["CLI","UpdateCliOutputOptions"],"host":["{{mainUrl}}v1"],"query":[],"variable":[]}},"response":[{"id":"28eaf9ff-2c48-45f0-8e7e-9e1893b00b0c","name":"Update CLI Output Options","originalRequest":{"method":"PUT","header":[{"key":"customerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"{\r\n \"CliId\": 30014,\r\n \"PrintSummary\": true,\r\n \"PrintAnalysis\": true,\r\n \"PrintItemisation\": true,\r\n \"EmailSummaryToAccount\": true,\r\n \"EmailAnalysisToAccount\": true,\r\n \"EmailItemisationToAccount\": true,\r\n \"EmailSummaryToBillPlan\": true,\r\n \"EmailAnalysisToBillPlan\": false,\r\n \"EmailItemisationToBillPlan\": true,\r\n \"EmailSummaryToCLI\": true,\r\n \"EmailAnalysisToCLI\": true,\r\n \"EmailItemisationToCLI\": true,\r\n \"AnalysisStyleId\": 1,\r\n \"ShowSavingOnSummary\": true,\r\n \"EmailCDRsToAccount\": true,\r\n \"EmailCDRsToBillPlan\": true,\r\n \"EmailCDRsToCLI\": true\r\n} \r\n","options":{"raw":{"language":"json"}}},"url":"{{mainUrl}}v1/CLI/UpdateCliOutputOptions"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"ReturnModel\": {\r\n \"CliId\": 30014,\r\n \"Cli\": \"APIMOBILE001\",\r\n \"BillPlan\": {\r\n \"Id\": 1956,\r\n \"Name\": \"Test Company Ltd\"\r\n },\r\n \"CustomerAccount\": {\r\n \"Id\": 2,\r\n \"AccountNumber\": \"INTELL01\",\r\n \"Name\": \"Test Company Ltd\"\r\n },\r\n \"BillingCompany\": {\r\n \"Id\": 4,\r\n \"Name\": \"Test Company Ltd\"\r\n },\r\n \"NumberDescription\": \"API_MOBILE_001_Amended\",\r\n \"CostCentre\": \"000\",\r\n \"CliType\": {\r\n \"Id\": 3,\r\n \"Description\": \"Mobile\"\r\n },\r\n \"ConnectionDate\": \"2022-10-01T00:00:00Z\",\r\n \"DisconnectionDate\": null,\r\n \"EmailAddress\": \"apimobiletest@informbilling.co.uk\",\r\n \"EquipmentType\": null,\r\n \"EquipmentSerialNo\": null,\r\n \"NumberOfLines\": 0,\r\n \"NumberOfChannels\": 0,\r\n \"AddressDetailsAccountNumber\": null,\r\n \"AddressDetailsAccountName\": null,\r\n \"AddressDetailsAddress\": null,\r\n \"AddressDetailsPostcode\": null,\r\n \"AddressDetailsWholesaleOrderNo\": null,\r\n \"CPSCentrexRef\": null,\r\n \"CPSOrderNumber\": null,\r\n \"CPSOptionId\": null,\r\n \"SIM\": \"SIM-001_Amended\",\r\n \"PUK\": \"PUK-001_Amended\",\r\n \"MailboxNumber\": null,\r\n \"DataNumber\": null,\r\n \"FaxNumber\": null,\r\n \"RestrictedNumbers\": null,\r\n \"CarrierContractStartDate\": \"2024-01-01T00:00:00Z\",\r\n \"CarrierContractEndDate\": \"2024-09-01T00:00:00Z\",\r\n \"CarrierContractLength\": 8,\r\n \"CarrierContractType\": {\r\n \"Id\": 5,\r\n \"ContractType\": \"New Number\",\r\n \"CliType\": {\r\n \"Id\": 3,\r\n \"Description\": \"Mobile\"\r\n }\r\n },\r\n \"UserContractStartDate\": \"2024-02-01T00:00:00Z\",\r\n \"UserContractEndDate\": \"2025-03-01T00:00:00Z\",\r\n \"UserContractLength\": 13,\r\n \"UserContractType\": {\r\n \"Id\": 6,\r\n \"ContractType\": \"Port\",\r\n \"CliType\": {\r\n \"Id\": 3,\r\n \"Description\": \"Mobile\"\r\n }\r\n },\r\n \"PAC\": \"PAC-001_Amended\",\r\n \"ShortCode\": \"ShortCode-001_Amended\",\r\n \"RoutingPlan\": null,\r\n \"DestP2PNumber\": null,\r\n \"UserDefinedField\": {\r\n \"Id\": 30014,\r\n \"Custom1\": null,\r\n \"Custom2\": null,\r\n \"Custom3\": null,\r\n \"Custom4\": null,\r\n \"Custom5\": null,\r\n \"Custom6\": null,\r\n \"Custom7\": null,\r\n \"Custom8\": null,\r\n \"Custom9\": \"Custom 9\",\r\n \"Custom10\": null,\r\n \"Custom11\": null,\r\n \"Custom12\": null,\r\n \"Custom13\": null,\r\n \"Custom14\": null,\r\n \"Custom15\": null\r\n },\r\n \"PrintSummary\": true,\r\n \"PrintAnalysis\": true,\r\n \"PrintItemisation\": true,\r\n \"EmailSummaryToAccount\": true,\r\n \"EmailAnalysisToAccount\": true,\r\n \"EmailItemisationToAccount\": true,\r\n \"EmailSummaryToBillPlan\": true,\r\n \"EmailAnalysisToBillPlan\": false,\r\n \"EmailItemisationToBillPlan\": true,\r\n \"EmailSummaryToCLI\": true,\r\n \"EmailAnalysisToCLI\": true,\r\n \"EmailItemisationToCLI\": true,\r\n \"AnalysisStyleId\": 1,\r\n \"ShowSavingOnSummary\": true,\r\n \"Creator\": \"admin\",\r\n \"EmailCDRsToAccount\": true,\r\n \"EmailCDRsToBillPlan\": true,\r\n \"EmailCDRsToCLI\": true,\r\n \"NTSClass\": null,\r\n \"NTSType\": null,\r\n \"CreatedDate\": \"2024-11-12T16:43:38.9Z\",\r\n \"IsDisconnected\": false,\r\n \"MobileLimitEnabled\": false,\r\n \"MobileLimitWarning\": null,\r\n \"MobileLimitLimit\": null,\r\n \"Dealer\": null,\r\n \"LowerBundleLimit\": 80,\r\n \"UpperBundleLimit\": 100,\r\n \"LowerAlertSpendLimit\": null,\r\n \"UpperAlertSpendLimit\": null,\r\n \"DataLimitEnabled\": false,\r\n \"DataLimitWarning\": 0,\r\n \"DataWarningUnitValue\": 1,\r\n \"DataLimitLimit\": 0,\r\n \"DataLimitUnitValue\": 1,\r\n \"TransferredToTelId\": null,\r\n \"OldNumberBankId\": null,\r\n \"EID\": null,\r\n \"IMSI\": null,\r\n \"ConnectionId\": \"\",\r\n \"IsPrimaryConnection\": true,\r\n \"CliToBeReconnected\": false,\r\n \"LastUpdated\": \"2024-12-06T16:54:44.7519525+00:00\",\r\n \"LastUpdatedForJigsaw\": \"2024-12-06T16:54:42.9651461+00:00\"\r\n },\r\n \"JobNumber\": null,\r\n \"MayRequireRerate\": true\r\n}"}],"_postman_id":"76669ba9-4327-4ad5-b2ae-2b92a9e9ee72"},{"name":"Update CLI User Defined Field","id":"14b2acdd-84ad-4ffa-9340-fc32fe0eb03b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access-token}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"{\n \"Id\": 30014,\n \"Custom1\": \"Custom 1 Client Gateway Updated\",\n \"Custom3\": \"Custom 3 Client Gateway Updated\",\n \"Custom5\": \"Custom 5 Client Gateway Updated\",\n \"Custom7\": \"Standard Customer\",\n \"Custom9\": \"Custom 9 Updated\",\n \"Custom11\": \"No\"\n}\n"},"url":"{{mainUrl}}v1/CLI/UpdateCliUserDefinedField","description":"Update Cli record for the user defined fields/custom fields by id based on setup.
\nMandatory fields for this endpoint are based on custom field/UDF setup, a 'Get Number Custom Fields' endpoint exists to retrieve this information.
\n","urlObject":{"path":["CLI","UpdateCliUserDefinedField"],"host":["{{mainUrl}}v1"],"query":[],"variable":[]}},"response":[{"id":"e077737c-763a-4b5c-91b4-af7421812cde","name":"Update CLI User Defined Field","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"CustomerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"{\n \"Id\": 30014,\n \"Custom1\": \"Custom 1 Client Gateway Updated\",\n \"Custom3\": \"Custom 3 Client Gateway Updated\",\n \"Custom5\": \"Custom 5 Client Gateway Updated\",\n \"Custom7\": \"Standard Customer\",\n \"Custom9\": \"Custom 9 Updated\",\n \"Custom11\": \"No\"\n}\n","options":{"raw":{"language":"json"}}},"url":"{{mainUrl}}v1/CLI/UpdateCliUserDefinedField"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnModel\": {\n \"CliId\": 30014,\n \"Cli\": \"APIMOBILE001\",\n \"BillPlan\": {\n \"Id\": 1956,\n \"Name\": \"Test Company Ltd\"\n },\n \"CustomerAccount\": {\n \"Id\": 2,\n \"AccountNumber\": \"INTELL01\",\n \"Name\": \"Test Company Ltd\"\n },\n \"BillingCompany\": {\n \"Id\": 4,\n \"Name\": \"Test Company Ltd\"\n },\n \"NumberDescription\": \"API_MOBILE_001_Amended\",\n \"CostCentre\": \"000\",\n \"CliType\": {\n \"Id\": 3,\n \"Description\": \"Mobile\"\n },\n \"ConnectionDate\": \"2022-10-01T00:00:00Z\",\n \"DisconnectionDate\": null,\n \"EmailAddress\": \"apimobiletest@informbilling.co.uk\",\n \"EquipmentType\": null,\n \"EquipmentSerialNo\": null,\n \"NumberOfLines\": 0,\n \"NumberOfChannels\": 0,\n \"AddressDetailsAccountNumber\": null,\n \"AddressDetailsAccountName\": null,\n \"AddressDetailsAddress\": null,\n \"AddressDetailsPostcode\": null,\n \"AddressDetailsWholesaleOrderNo\": null,\n \"CPSCentrexRef\": null,\n \"CPSOrderNumber\": null,\n \"CPSOptionId\": null,\n \"SIM\": \"SIM-001_Amended\",\n \"PUK\": \"PUK-001_Amended\",\n \"MailboxNumber\": null,\n \"DataNumber\": null,\n \"FaxNumber\": null,\n \"RestrictedNumbers\": null,\n \"CarrierContractStartDate\": \"2024-01-01T00:00:00Z\",\n \"CarrierContractEndDate\": \"2024-09-01T00:00:00Z\",\n \"CarrierContractLength\": 8,\n \"CarrierContractType\": {\n \"Id\": 5,\n \"ContractType\": \"New Number\",\n \"CliType\": {\n \"Id\": 3,\n \"Description\": \"Mobile\"\n }\n },\n \"UserContractStartDate\": \"2024-02-01T00:00:00Z\",\n \"UserContractEndDate\": \"2025-03-01T00:00:00Z\",\n \"UserContractLength\": 13,\n \"UserContractType\": {\n \"Id\": 6,\n \"ContractType\": \"Port\",\n \"CliType\": {\n \"Id\": 3,\n \"Description\": \"Mobile\"\n }\n },\n \"PAC\": \"PAC-001_Amended\",\n \"ShortCode\": \"ShortCode-001_Amended\",\n \"RoutingPlan\": null,\n \"DestP2PNumber\": null,\n \"UserDefinedField\": {\n \"Id\": 30014,\n \"Custom1\": \"Custom 1 Client Gateway Updated\",\n \"Custom2\": null,\n \"Custom3\": \"Custom 3 Client Gateway Updated\",\n \"Custom4\": null,\n \"Custom5\": \"Custom 5 Client Gateway Updated\",\n \"Custom6\": null,\n \"Custom7\": \"Standard Customer\",\n \"Custom8\": null,\n \"Custom9\": \"Custom 9 Updated\",\n \"Custom10\": null,\n \"Custom11\": \"No\",\n \"Custom12\": null,\n \"Custom13\": null,\n \"Custom14\": null,\n \"Custom15\": null\n },\n \"PrintSummary\": true,\n \"PrintAnalysis\": true,\n \"PrintItemisation\": true,\n \"EmailSummaryToAccount\": true,\n \"EmailAnalysisToAccount\": true,\n \"EmailItemisationToAccount\": true,\n \"EmailSummaryToBillPlan\": true,\n \"EmailAnalysisToBillPlan\": false,\n \"EmailItemisationToBillPlan\": true,\n \"EmailSummaryToCLI\": true,\n \"EmailAnalysisToCLI\": true,\n \"EmailItemisationToCLI\": true,\n \"AnalysisStyleId\": 1,\n \"ShowSavingOnSummary\": true,\n \"Creator\": \"admin\",\n \"EmailCDRsToAccount\": true,\n \"EmailCDRsToBillPlan\": true,\n \"EmailCDRsToCLI\": true,\n \"NTSClass\": null,\n \"NTSType\": null,\n \"CreatedDate\": \"2024-11-12T16:43:38.9Z\",\n \"IsDisconnected\": false,\n \"MobileLimitEnabled\": false,\n \"MobileLimitWarning\": null,\n \"MobileLimitLimit\": null,\n \"Dealer\": null,\n \"LowerBundleLimit\": 80,\n \"UpperBundleLimit\": 100,\n \"LowerAlertSpendLimit\": null,\n \"UpperAlertSpendLimit\": null,\n \"DataLimitEnabled\": false,\n \"DataLimitWarning\": 0,\n \"DataWarningUnitValue\": 1,\n \"DataLimitLimit\": 0,\n \"DataLimitUnitValue\": 1,\n \"TransferredToTelId\": null,\n \"OldNumberBankId\": null,\n \"EID\": null,\n \"IMSI\": null,\n \"ConnectionId\": \"\",\n \"IsPrimaryConnection\": true,\n \"CliToBeReconnected\": false,\n \"LastUpdated\": \"2024-12-06T16:54:44.7519525+00:00\",\n \"LastUpdatedForJigsaw\": \"2024-12-06T16:54:42.9651461+00:00\"\n },\n \"JobNumber\": null,\n \"MayRequireRerate\": true\n}"}],"_postman_id":"14b2acdd-84ad-4ffa-9340-fc32fe0eb03b"}],"id":"c768be51-3faa-4318-b8a0-5ab1cab43d80","_postman_id":"c768be51-3faa-4318-b8a0-5ab1cab43d80","description":""},{"name":"v2","item":[{"name":"Search CLI Paged","id":"6dc87c82-054b-4dfc-a556-d6f5d9774933","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access-token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"{ \n \"GroupedFilterExpressions\": [\n {\n \"FilterExpressions\": [\n {\n \"FieldName\": \"Cli\",\n \"FieldValue\": \"NG3831CLI12\",\n \"FilterFunction\": \"EqualTo\"\n }\n ],\n \"FilterExpressionsUsingOR\": false\n }\n ], \n \"SortExpressions\": [\n {\n \"FieldName\": \"CliId\",\n \"SortOrder\": \"Descending\"\n }\n ],\n \"PageNumber\": 1,\n \"PageSize\": 50\n}"},"url":"{{mainUrl}}v2/CLI/SearchCliPaged","description":"Searches CLI data with pagination and sorting.
\n","urlObject":{"path":["CLI","SearchCliPaged"],"host":["{{mainUrl}}v2"],"query":[],"variable":[]}},"response":[{"id":"781a4e34-565b-4f00-acd9-7ddd79fce083","name":"Search CLI Paged","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"{ \n \"GroupedFilterExpressions\": [\n {\n \"FilterExpressions\": [\n {\n \"FieldName\": \"Cli\",\n \"FieldValue\": \"NG3831CLI12\",\n \"FilterFunction\": \"EqualTo\"\n }\n ],\n \"FilterExpressionsUsingOR\": false\n }\n ], \n \"SortExpressions\": [\n {\n \"FieldName\": \"CliId\",\n \"SortOrder\": \"Descending\"\n }\n ],\n \"PageNumber\": 1,\n \"PageSize\": 50\n}","options":{"raw":{"language":"json"}}},"url":"{{mainUrl}}v2/CLI/SearchCliPaged"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnModel\": {\n \"CurrentPage\": 1,\n \"TotalPages\": 1,\n \"TotalItems\": 1,\n \"ItemsPerPage\": 50,\n \"Items\": [\n {\n \"CliId\": 1050,\n \"Cli\": \"NG3831CLI12\",\n \"BillPlan\": {\n \"Id\": 1956,\n \"Name\": \"Bill Plan Name\"\n },\n \"CustomerAccount\": {\n \"Id\": 2,\n \"AccountNumber\": \"ACC001\",\n \"Name\": \"Account Name\"\n },\n \"BillingCompany\": {\n \"Id\": 4,\n \"Name\": \"Billing Company Name\"\n },\n \"NumberDescription\": \"CLI Description\",\n \"CostCentre\": \"Cost Centre\",\n \"CliType\": {\n \"Id\": 2,\n \"Description\": \"Inbound NTS\"\n },\n \"ConnectionDate\": \"2024-11-01T00:00:00Z\",\n \"DisconnectionDate\": null,\n \"EmailAddress\": \"joebloggs@informbilling.co.uk\",\n \"EquipmentType\": null,\n \"EquipmentSerialNo\": \"Equipment Serial No\",\n \"NumberOfLines\": 0,\n \"NumberOfChannels\": 0,\n \"AddressDetailsAccountNumber\": \"Address Details Account Number\",\n \"AddressDetailsAccountName\": \"Address Details Account Name\",\n \"AddressDetailsAddress\": \"Address Details Address\",\n \"AddressDetailsPostcode\": \"Address Details Postcode\",\n \"AddressDetailsWholesaleOrderNo\": \"Address Details Wholesale Order No\",\n \"CPSCentrexRef\": \"CPS Centrex Ref\",\n \"CPSOrderNumber\": \"CPS Order Number\",\n \"CPSOptionId\": \"CPS Option Id\",\n \"SIM\": null,\n \"PUK\": null,\n \"MailboxNumber\": null,\n \"DataNumber\": null,\n \"FaxNumber\": null,\n \"RestrictedNumbers\": null,\n \"CarrierContractStartDate\": \"2020-03-01T00:00:00Z\",\n \"CarrierContractEndDate\": \"2020-04-01T00:00:00Z\",\n \"CarrierContractLength\": 1,\n \"CarrierContractContractType\": {\n \"Id\": 10,\n \"ContractType\": \"New Number\",\n \"CliType\": {\n \"Id\": 2,\n \"Description\": \"Inbound NTS\"\n }\n },\n \"UserContractStartDate\": \"2023-05-18T00:00:00Z\",\n \"UserContractEndDate\": \"2024-05-18T00:00:00Z\",\n \"UserContractLength\": 12,\n \"UserContractContractType\": {\n \"Id\": 10,\n \"ContractType\": \"New Number\",\n \"CliType\": {\n \"Id\": 2,\n \"Description\": \"Inbound NTS\"\n }\n },\n \"PAC\": null,\n \"ShortCode\": null,\n \"RoutingPlan\": {\n \"Id\": 1,\n \"Description\": \"Simple Point-to-Point\"\n },\n \"DestP2PNumber\": \"\",\n \"UserDefinedField\": {\n \"Id\": 1050,\n \"Custom1\": \"Custom1\",\n \"Custom2\": \"Custom2\",\n \"Custom3\": \"Custom3\",\n \"Custom4\": \"Custom4\",\n \"Custom5\": \"Custom5\",\n \"Custom6\": \"Custom6\",\n \"Custom7\": \"Custom7\",\n \"Custom8\": \"Custom8\",\n \"Custom9\": \"Custom9\",\n \"Custom10\": \"Custom10\",\n \"Custom11\": \"Custom11\",\n \"Custom12\": \"Custom12\",\n \"Custom13\": \"Custom13\",\n \"Custom14\": \"Custom14\",\n \"Custom15\": \"Custom15\"\n },\n \"PrintSummary\": true,\n \"PrintAnalysis\": true,\n \"PrintItemisation\": true,\n \"EmailSummaryToAccount\": true,\n \"EmailAnalysisToAccount\": true,\n \"EmailItemisationToAccount\": true,\n \"EmailSummaryToBillPlan\": true,\n \"EmailAnalysisToBillPlan\": true,\n \"EmailItemisationToBillPlan\": true,\n \"EmailSummaryToCLI\": true,\n \"EmailAnalysisToCLI\": true,\n \"EmailItemisationToCLI\": true,\n \"AnalysisStyle\": 1,\n \"ShowSavingOnSummary\": true,\n \"Creator\": \"joebloggs\",\n \"EmailCDRsToAccount\": true,\n \"EmailCDRsToBillPlan\": true,\n \"EmailCDRsToCLI\": true,\n \"NTSClass\": {\n \"Id\": 5,\n \"Description\": \"Platinum\"\n },\n \"NTSType\": {\n \"Id\": 4,\n \"Description\": \"Inbound NTS 0870/0871 National Rate\"\n },\n \"CreatedDate\": \"2023-03-20T11:53:56.533Z\",\n \"IsDisconnected\": false,\n \"MobileLimitEnabled\": false,\n \"MobileLimitWarning\": null,\n \"MobileLimitLimit\": null,\n \"Dealer\": null,\n \"LowerBundleLimit\": 80,\n \"UpperBundleLimit\": 100,\n \"LowerAlertSpendLimit\": null,\n \"UpperAlertSpendLimit\": null,\n \"DataLimitEnabled\": false,\n \"DataLimitWarning\": null,\n \"DataWarningUnitValue\": 3,\n \"DataLimitLimit\": null,\n \"DataLimitUnitValue\": 3,\n \"TransferredToTelId\": null,\n \"OldNumberBankId\": null,\n \"EID\": null,\n \"IMSI\": null,\n \"ConnectionId\": null,\n \"IsPrimaryConnection\": true,\n \"CliToBeReconnected\": false,\n \"LastUpdated\": \"2024-11-01T11:37:21.2141113+00:00\",\n \"LastUpdatedForJigsaw\": \"2024-11-01T11:37:17.3127261+00:00\"\n }\n ]\n },\n \"JobNumber\": null,\n \"MayRequireRerate\": false\n}"}],"_postman_id":"6dc87c82-054b-4dfc-a556-d6f5d9774933"}],"id":"83fa94ea-572e-4f00-b91e-0af20deda635","_postman_id":"83fa94ea-572e-4f00-b91e-0af20deda635","description":""}],"id":"41f22808-dc20-43fc-9839-a97a9d0fa640","_postman_id":"41f22808-dc20-43fc-9839-a97a9d0fa640","description":""},{"name":"Lookup","item":[{"name":"v1","item":[{"name":"Get Equipment Types","id":"429705b7-e8ec-493f-95b0-82c188082435","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access-token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{mainUrl}}v1/Lookup/GetEquipmentTypes","urlObject":{"path":["Lookup","GetEquipmentTypes"],"host":["{{mainUrl}}v1"],"query":[],"variable":[]}},"response":[{"id":"9ad60b28-a2d9-4758-bba3-d150cbaf310a","name":"Get Equipment Types","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"url":"{{mainUrl}}v1/Lookup/GetEquipmentTypes"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnModel\": [\n {\n \"Id\": 3,\n \"Description\": \"Phone\"\n },\n {\n \"Id\": 5,\n \"Description\": \"Fax\"\n },\n {\n \"Id\": 6,\n \"Description\": \"Modem\"\n },\n {\n \"Id\": 7,\n \"Description\": \"PDQ\"\n },\n {\n \"Id\": 8,\n \"Description\": \"Payphone\"\n },\n {\n \"Id\": 9,\n \"Description\": \"FAX / Phone / Modem\"\n },\n {\n \"Id\": 10,\n \"Description\": \"No Information Yet\"\n },\n {\n \"Id\": 12,\n \"Description\": \"Own Hardware\"\n },\n {\n \"Id\": 14,\n \"Description\": \"Fax/Phone\"\n },\n {\n \"Id\": 23,\n \"Description\": \"SIM Only\"\n },\n {\n \"Id\": 24,\n \"Description\": \"VoIP 2-Port Adaptor (ATA)\"\n }\n ],\n \"JobNumber\": null,\n \"MayRequireRerate\": false\n}"}],"_postman_id":"429705b7-e8ec-493f-95b0-82c188082435"},{"name":"Get Cli Types","id":"29b8aa8b-08ae-4510-9604-2080fbcc976d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access-token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{mainUrl}}v1/Lookup/GetCliTypes","urlObject":{"path":["Lookup","GetCliTypes"],"host":["{{mainUrl}}v1"],"query":[],"variable":[]}},"response":[{"id":"9faf9ba3-7ec1-4f14-b6c4-6da1a172ae0d","name":"Get Cli Types","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"url":"{{mainUrl}}v1/Lookup/GetCliTypes"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnModel\": [\n {\n \"Id\": 1,\n \"Description\": \"Fixed\"\n },\n {\n \"Id\": 2,\n \"Description\": \"Inbound NTS\"\n },\n {\n \"Id\": 3,\n \"Description\": \"Mobile\"\n }\n ],\n \"JobNumber\": null,\n \"MayRequireRerate\": false\n}"}],"_postman_id":"29b8aa8b-08ae-4510-9604-2080fbcc976d"},{"name":"Get Cli Contract Types","id":"1af0e493-db94-4adb-81dd-007490d63160","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access-token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{mainUrl}}v1/Lookup/GetContractTypes","urlObject":{"path":["Lookup","GetContractTypes"],"host":["{{mainUrl}}v1"],"query":[],"variable":[]}},"response":[{"id":"802bd3cc-5377-4d85-9dd2-cbaf83c08747","name":"Get Cli Contract Types","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"url":"{{mainUrl}}v1/Lookup/GetContractTypes"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnModel\": [\n {\n \"Id\": 1,\n \"ContractType\": \"New Number\",\n \"CliType\": {\n \"Id\": 1,\n \"Description\": \"Fixed\"\n }\n },\n {\n \"Id\": 5,\n \"ContractType\": \"New Number\",\n \"CliType\": {\n \"Id\": 3,\n \"Description\": \"Mobile\"\n }\n },\n {\n \"Id\": 10,\n \"ContractType\": \"New Number\",\n \"CliType\": {\n \"Id\": 2,\n \"Description\": \"Inbound NTS\"\n }\n }\n ],\n \"JobNumber\": null,\n \"MayRequireRerate\": false\n}"}],"_postman_id":"1af0e493-db94-4adb-81dd-007490d63160"},{"name":"Get Routing Plans","id":"5634b24f-6682-4078-bdec-261b32025f37","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access-token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{mainUrl}}v1/Lookup/GetRoutingPlans","urlObject":{"path":["Lookup","GetRoutingPlans"],"host":["{{mainUrl}}v1"],"query":[],"variable":[]}},"response":[{"id":"3f951ef0-b87f-4300-92f4-29cc1b0c064a","name":"Get Routing Plans","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"url":"{{mainUrl}}v1/Lookup/GetRoutingPlans"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnModel\": [\n {\n \"Id\": 1,\n \"Description\": \"Simple Point-to-Point\"\n },\n {\n \"Id\": 2,\n \"Description\": \"Complex Route\"\n }\n ],\n \"JobNumber\": null,\n \"MayRequireRerate\": false\n}"}],"_postman_id":"5634b24f-6682-4078-bdec-261b32025f37"},{"name":"Get NTS Classes","id":"67399ad9-0e08-4609-b6c6-9bd09df856d7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access-token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{mainUrl}}v1/Lookup/GetNTSClasses","urlObject":{"path":["Lookup","GetNTSClasses"],"host":["{{mainUrl}}v1"],"query":[],"variable":[]}},"response":[{"id":"40d387d3-33ae-46bd-b15c-fb5f644993ef","name":"Get NTS Classes","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"url":"{{mainUrl}}v1/Lookup/GetNTSClasses"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnModel\": [\n {\n \"Id\": 1,\n \"Description\": \"Standard\"\n },\n {\n \"Id\": 2,\n \"Description\": \"Bronze\"\n },\n {\n \"Id\": 3,\n \"Description\": \"Silver\"\n },\n {\n \"Id\": 4,\n \"Description\": \"Gold\"\n },\n {\n \"Id\": 5,\n \"Description\": \"Platinum\"\n }\n ],\n \"JobNumber\": null,\n \"MayRequireRerate\": false\n}"}],"_postman_id":"67399ad9-0e08-4609-b6c6-9bd09df856d7"},{"name":"Get NTS Types","id":"42ff39cb-7dc6-4ef2-b966-3314fbae2b2a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access-token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{mainUrl}}v1/Lookup/GetNTSTypes","urlObject":{"path":["Lookup","GetNTSTypes"],"host":["{{mainUrl}}v1"],"query":[],"variable":[]}},"response":[{"id":"879532fa-0a15-4c13-baad-4f44605ac181","name":"Get NTS Types","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"url":"{{mainUrl}}v1/Lookup/GetNTSTypes"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnModel\": [\n {\n \"Id\": 1,\n \"Description\": \"Inbound NTS 0800/0808 Freephone\"\n },\n {\n \"Id\": 4,\n \"Description\": \"Inbound NTS 0870/0871 National Rate\"\n },\n {\n \"Id\": 5,\n \"Description\": \"Inbound NTS 0845/0844 Lo-Call\"\n },\n {\n \"Id\": 6,\n \"Description\": \"Inbound NTS 09 Premium\"\n }\n ],\n \"JobNumber\": null,\n \"MayRequireRerate\": false\n}"}],"_postman_id":"42ff39cb-7dc6-4ef2-b966-3314fbae2b2a"}],"id":"5176a80f-3d4a-4b36-8763-0e12b559278d","_postman_id":"5176a80f-3d4a-4b36-8763-0e12b559278d","description":""}],"id":"7f9be292-e7ad-40ae-9c1d-be7af195175d","description":"Contains endpoints relating to lookups which provide Id's which are required when creating and updating CLI(s).
\n","_postman_id":"7f9be292-e7ad-40ae-9c1d-be7af195175d"},{"name":"Subscription Status","item":[{"name":"Search Cli Subscription Status Paged","id":"cb2fe649-8bec-4e6b-95b5-1bf4ef75021c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access-token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"customerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"{ \r\n \"GroupedFilterExpressions\":[\r\n {\r\n \"FilterExpressions\": [\r\n { \r\n \"FieldName\":\"SubscriptionStatus.Id\",\r\n \"FieldValue\":\"2\",\r\n \"FilterFunction\": \"EqualTo\"\r\n }\r\n ]\r\n }\r\n ],\r\n \"SortExpressions\": [\r\n {\r\n \"FieldName\": \"CliId\",\r\n \"SortOrder\": \"Ascending\"\r\n }\r\n ],\r\n \"PageNumber\": 1,\r\n \"PageSize\": 50\r\n}","options":{"raw":{"language":"json"}}},"url":"{{mainUrl}}v1/SubscriptionStatus/SearchCliSubscriptionStatusPaged","urlObject":{"path":["SubscriptionStatus","SearchCliSubscriptionStatusPaged"],"host":["{{mainUrl}}v1"],"query":[],"variable":[]}},"response":[{"id":"cff8ab4e-1978-416d-9f47-8484a53b4764","name":"Search Cli Subscription Status Paged","originalRequest":{"method":"POST","header":[{"key":"customerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"{ \r\n \"GroupedFilterExpressions\":[\r\n {\r\n \"FilterExpressions\": [\r\n { \r\n \"FieldName\":\"SubscriptionStatus.Id\",\r\n \"FieldValue\":\"2\",\r\n \"FilterFunction\": \"EqualTo\"\r\n }\r\n ]\r\n }\r\n ],\r\n \"SortExpressions\": [\r\n {\r\n \"FieldName\": \"CliId\",\r\n \"SortOrder\": \"Ascending\"\r\n }\r\n ],\r\n \"PageNumber\": 1,\r\n \"PageSize\": 50\r\n}","options":{"raw":{"language":"json"}}},"url":"{{mainUrl}}v1/SubscriptionStatus/SearchCliSubscriptionStatusPaged"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnModel\": {\n \"CurrentPage\": 1,\n \"TotalPages\": 1,\n \"TotalItems\": 2,\n \"ItemsPerPage\": 50,\n \"Items\": [\n {\n \"CliId\": 1242,\n \"ConnectionId\": null,\n \"SubscriptionStatus\": {\n \"Id\": 2,\n \"Name\": \"Active\"\n },\n \"LastUpdated\": \"2024-11-08T11:41:15.1084916+00:00\"\n },\n {\n \"CliId\": 1243,\n \"ConnectionId\": null,\n \"SubscriptionStatus\": {\n \"Id\": 2,\n \"Name\": \"Active\"\n },\n \"LastUpdated\": \"2024-11-08T11:41:17.2996611+00:00\"\n }\n ]\n },\n \"JobNumber\": null,\n \"MayRequireRerate\": false\n}"}],"_postman_id":"cb2fe649-8bec-4e6b-95b5-1bf4ef75021c"},{"name":"Get Pick Subscription Statuses","id":"9bc58dc4-f75d-466e-a254-6d252f8fa91e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access-token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"customerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{mainUrl}}v1/SubscriptionStatus/GetPickSubscriptionStatuses","urlObject":{"path":["SubscriptionStatus","GetPickSubscriptionStatuses"],"host":["{{mainUrl}}v1"],"query":[],"variable":[]}},"response":[{"id":"d283b74f-1e82-49cd-a90d-ddf21c2e2ad1","name":"Get Pick Subscription Statuses","originalRequest":{"method":"GET","header":[{"key":"customerKey","value":"{{customerKey}}"}],"url":"{{mainUrl}}v1/SubscriptionStatus/GetPickSubscriptionStatuses"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnModel\": [\n {\n \"Id\": 1,\n \"Name\": \"Test\"\n },\n {\n \"Id\": 2,\n \"Name\": \"Active\"\n },\n {\n \"Id\": 3,\n \"Name\": \"Deactivated\"\n }\n ],\n \"JobNumber\": null,\n \"MayRequireRerate\": false\n}"}],"_postman_id":"9bc58dc4-f75d-466e-a254-6d252f8fa91e"}],"id":"0e6f956c-3b79-4551-a2ad-600a7f955237","_postman_id":"0e6f956c-3b79-4551-a2ad-600a7f955237","description":""}],"id":"47c1d31c-e30b-4ec1-b093-5722af93cdaf","description":"Contains endpoints relating to the CLI.
\n","_postman_id":"47c1d31c-e30b-4ec1-b093-5722af93cdaf"},{"name":"Company","item":[{"name":"v1","item":[{"name":"Get Companies","id":"edea6a1f-9d28-4589-b40a-51c446c33bca","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access-token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":""},"url":"{{mainUrl}}v1/Company/GetCompanies","description":"Gets the billing companies.
\n","urlObject":{"path":["Company","GetCompanies"],"host":["{{mainUrl}}v1"],"query":[],"variable":[]}},"response":[{"id":"ac8b741e-1f2b-4b7d-b340-15e32e6c6655","name":"Get Companies","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{mainUrl}}v1/Company/GetCompanies"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\r\n \"ReturnModel\": [\r\n {\r\n \"Id\": 4,\r\n \"Name\": \"Company Name\",\r\n \"Address\": \"The Street\\r\\nThe Town\\r\\nThe County\\r\\nAB1 2CD\",\r\n \"Number\": \"Company Number\",\r\n \"ResellerId\": \"Reseller Id\",\r\n \"VatNo\": \"Vat No\",\r\n \"SubResellerAccount\": false,\r\n \"DefaultAdditionalInvoiceText\": \"Default Additional Invoice Text\",\r\n \"DealerStatementStyle\": \"Default Eclipse Style\",\r\n \"NextInvoiceNumber\": 100017,\r\n \"NextStatementNumber\": 500000,\r\n \"InvoiceNumberPrefix\": \"Prefix\",\r\n \"SMTPFrom\": \"joebloggs@infrombilling.co.uk\",\r\n \"SMTPBCC\": \"janedoe@informbilling.co.uk\",\r\n \"EmailedBills\": \"Email Bills\",\r\n \"AllowCarrierNameOverride\": false,\r\n \"CarrierNameOverrideText\": \"Carrier Name Override Text\",\r\n \"EmailedCDRs\": \"Emailed CDRs\",\r\n \"EmailedSalesInvoices\": \"Emailed Sales Invoices\",\r\n \"EmailedAutomatedBillingReports\": \"Emailed Automated Billing Reports\",\r\n \"EmailedDealerStatements\": \"Emailed Dealer Statements\",\r\n \"AddressTopPosition\": 2325,\r\n \"AddressLeftPosition\": 975,\r\n \"ShowLogoOnPrintedBills\": false,\r\n \"ShowAddressBlock\": false,\r\n \"ShowDisclaimer\": false,\r\n \"PrintedCurrencySymbol\": \"£\",\r\n \"AddressBlockText\": \"Address Block Text\",\r\n \"CustomInvoiceText\": \"Custom Invoice Text\",\r\n \"UseRegisteredCompanyText\": false,\r\n \"CdrSubject\": \"Cdr Subject\",\r\n \"SendEmailNotifications\": false,\r\n \"AccountLevelEmails\": false,\r\n \"AccountLevelSettings\": 1,\r\n \"CliLevelEmails\": false,\r\n \"CLILevelSettings\": 1,\r\n \"EmailNotificationsSentFrom\": \"joebloggs@infrombilling.co.uk\",\r\n \"EmailNotificationSubject\": \"Email Notification Subject\",\r\n \"EmailNotificationBody\": \"Email Notification Body\",\r\n \"LastUpdated\": \"2024-07-05T15:43:34.5736558+01:00\"\r\n }\r\n ],\r\n \"JobNumber\": null,\r\n \"MayRequireRerate\": false\r\n}"}],"_postman_id":"edea6a1f-9d28-4589-b40a-51c446c33bca"}],"id":"313ee2db-0574-4b3c-a2b0-31391d049c71","_postman_id":"313ee2db-0574-4b3c-a2b0-31391d049c71","description":""}],"id":"77226c88-5849-484b-8b36-e76cc2d9672f","description":"Contains endpoints relating to the company.
\n","_postman_id":"77226c88-5849-484b-8b36-e76cc2d9672f"},{"name":"Custom Fields","item":[{"name":"v1","item":[{"name":"Get Number Custom Fields","id":"c260b540-9a66-47f4-9067-151daa66cbb1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access-token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":""},"url":"{{mainUrl}}v1/CustomField/GetNumberCustomFields","description":"Gets the Custom fields enabled for phonenumbers.
\n","urlObject":{"path":["CustomField","GetNumberCustomFields"],"host":["{{mainUrl}}v1"],"query":[],"variable":[]}},"response":[{"id":"6a9b7a23-206c-4e4c-8f14-7a772a9b5697","name":"Get Number Custom Fields","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"url":"{{mainUrl}}v1/CustomField/GetNumberCustomFields"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnModel\": [\n {\n \"FieldName\": \"Field1\",\n \"FrontEndName\": \"Field 1\",\n \"IsMandatory\": true,\n \"IsDataList\": true,\n \"IsLimitToList\": false,\n \"DataList\": [\n {\n \"FieldValue\": \"Value1\"\n },\n {\n \"FieldValue\": \"Value2\"\n },\n {\n \"FieldValue\": \"Value3\"\n }\n ]\n },\n {\n \"FieldName\": \"Field2\",\n \"FrontEndName\": \"Field 2\",\n \"IsMandatory\": true,\n \"IsDataList\": true,\n \"IsLimitToList\": false,\n \"DataList\": []\n }\n ],\n \"JobNumber\": null,\n \"MayRequireRerate\": false\n}"}],"_postman_id":"c260b540-9a66-47f4-9067-151daa66cbb1"},{"name":"Get Bill Plan Custom Fields","id":"110bfa44-85c2-4710-9fd3-c38819339ec3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access-token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":""},"url":"{{mainUrl}}v1/CustomField/GetBillPlanCustomFields","description":"Gets the Custom fields enabled for bill plans.
\n","urlObject":{"path":["CustomField","GetBillPlanCustomFields"],"host":["{{mainUrl}}v1"],"query":[],"variable":[]}},"response":[{"id":"45af5373-17b9-4111-83ba-233658ed3e04","name":"Get Bill Plan Custom Fields","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"url":"{{mainUrl}}v1/CustomField/GetBillPlanCustomFields"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnModel\": [\n {\n \"FieldName\": \"Field1\",\n \"FrontEndName\": \"Field 1\",\n \"IsMandatory\": true,\n \"IsDataList\": true,\n \"IsLimitToList\": false,\n \"DataList\": [\n {\n \"FieldValue\": \"Value1\"\n },\n {\n \"FieldValue\": \"Value2\"\n },\n {\n \"FieldValue\": \"Value3\"\n }\n ]\n },\n {\n \"FieldName\": \"Field2\",\n \"FrontEndName\": \"Field 2\",\n \"IsMandatory\": true,\n \"IsDataList\": true,\n \"IsLimitToList\": false,\n \"DataList\": []\n }\n ],\n \"JobNumber\": null,\n \"MayRequireRerate\": false\n}"}],"_postman_id":"110bfa44-85c2-4710-9fd3-c38819339ec3"},{"name":"Get Account Custom Fields","id":"e52facf3-3f65-46c6-ab19-123a46d6b9b4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{access-token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"body":{"mode":"raw","raw":""},"url":"{{mainUrl}}v1/CustomField/GetAccountCustomFields","description":"Gets the Custom fields enabled for accounts.
\n","urlObject":{"path":["CustomField","GetAccountCustomFields"],"host":["{{mainUrl}}v1"],"query":[],"variable":[]}},"response":[{"id":"e18f26c4-f1df-4176-a8d2-105c2ad43084","name":"Get Account Custom Fields","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"CustomerKey","value":"{{customerKey}}"}],"url":"{{mainUrl}}v1/CustomField/GetAccountCustomFields"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"ReturnModel\": [\n {\n \"FieldName\": \"Field1\",\n \"FrontEndName\": \"Field 2\",\n \"IsMandatory\": true,\n \"IsDataList\": true,\n \"IsLimitToList\": false,\n \"DataList\": [\n {\n \"FieldValue\": \"Value1\"\n },\n {\n \"FieldValue\": \"Value2\"\n },\n {\n \"FieldValue\": \"Value3\"\n },\n {\n \"FieldValue\": \"Value4\"\n },\n {\n \"FieldValue\": \"Value5\"\n }\n ]\n },\n {\n \"FieldName\": \"Field2\",\n \"FrontEndName\": \"Field 2\",\n \"IsMandatory\": false,\n \"IsDataList\": true,\n \"IsLimitToList\": true,\n \"DataList\": [\n {\n \"FieldValue\": \"Value1\"\n },\n {\n \"FieldValue\": \"Value2\"\n },\n {\n \"FieldValue\": \"Value3\"\n },\n {\n \"FieldValue\": \"Value4\"\n },\n {\n \"FieldValue\": \"Value5\"\n }\n ]\n },\n {\n \"FieldName\": \"Field3\",\n \"FrontEndName\": \"Field 3\",\n \"IsMandatory\": false,\n \"IsDataList\": false,\n \"IsLimitToList\": false,\n \"DataList\": []\n }\n ],\n \"JobNumber\": null,\n \"MayRequireRerate\": false\n}"}],"_postman_id":"e52facf3-3f65-46c6-ab19-123a46d6b9b4"}],"id":"b611a5a2-2029-4f3f-a198-f8fdcf503bc2","_postman_id":"b611a5a2-2029-4f3f-a198-f8fdcf503bc2","description":""}],"id":"cc827741-9cfb-4a81-9445-b5ccd7ec617c","description":"Contains endpoints relating to the custom fields/user defined fields.
\n","_postman_id":"cc827741-9cfb-4a81-9445-b5ccd7ec617c"}],"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"77e3534e-edb7-4c7e-a83d-09fff9549f45"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"18a54b7c-e9c6-4a51-8730-176cb821aa26"}}]}