{"items":[{"type":"link","label":"Overview","link":"/openapi/billingcodes","routeSlug":"/openapi/billingcodes","content":{"contentType":"overview","meta":{"name":"Overview"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"billingcodes.json","url":"/_bundle/openapi/billingcodes.json?download"},{"kind":"download","label":"billingcodes.yaml","url":"/_bundle/openapi/billingcodes.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"License","titleTranslationKey":"info.license","label":"PB Software License Agreement","url":"https://www.pitneybowes.com/us/support/account/pitney-bowes-terms-and-conditions.html"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/costaccountmgmt","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/costaccountmgmt","description":"Production Server (uses live data)"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Overview (1.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"CRUD operations to manage "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"billing codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"company codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A billing code is a customer-defined identifier (e.g., an account or company) that can be attached to shipments, invoices, or reports."},"children":[]}]}]}]}],"sectionId":"/openapi/billingcodes"}],"sectionId":"/openapi/billingcodes"}]}]}},{"type":"group","label":"Account Code","link":"/openapi/billingcodes/account-code","routeSlug":"/openapi/billingcodes/account-code","items":[{"label":"Create Account Code","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/billingcodes/account-code/createaccountcode","routeSlug":"/openapi/billingcodes/account-code/createaccountcode","metadata":{"seo":{"title":"Create Account Code","description":"Creates a new Account Code record. The code should be unique per tenant."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createAccountCode","name":"Create Account Code","isWebhook":false,"pointer":"/paths/~1api~1v1~1accountCodes/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Account Code","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a new Account Code record. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" should be unique per tenant."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-PB-Developer-Partner-ID","in":"header","schemaId":"schema_242","description":"This is the Developer Partner ID. When the developer is the only partner, this field is not required."}],"pointer":"/paths/~1api~1v1~1accountCodes/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateAccountCodeRequest"}},"schemaId":"components/schemas/CreateAccountCodeRequest","pointer":"/paths/~1api~1v1~1accountCodes/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/accountCodes","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/costaccountmgmt","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/costaccountmgmt","description":"Production Server (uses live data)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-PB-Developer-Partner-ID","in":"header","required":false,"schemaId":"schema_242"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateAccountCodeRequest"}},"responseCodes":["201","400","401","500"],"pointer":"/api/v1/accountCodes","href":"account-code/createaccountcode","openApiOperationId":"createAccountCode","summary":"Create Account Code"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/costaccountmgmt","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/costaccountmgmt","description":"Production Server (uses live data)"}],"schemaId":"components/schemas/CreateAccountCodeRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateAccountCodeRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Account Code has been generated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountCodeCreated"}},"schemaId":"components/schemas/AccountCodeCreated"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"500","description":"The request could not be completed due to an internal error."}],"pointer":"/paths/~1api~1v1~1accountCodes/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/AccountCodeCreated","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountCodeCreated"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-code/createaccountcode"}],"panels":[]}]},"httpPath":"/api/v1/accountCodes"},{"label":"Get Account Codes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/billingcodes/account-code/getaccountcodes","routeSlug":"/openapi/billingcodes/account-code/getaccountcodes","metadata":{"seo":{"title":"Get Account Codes","description":"Returns a list of Account Codes.Use sortBy to sort results by a supported field and direction."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAccountCodes","name":"Get Account Codes","isWebhook":false,"pointer":"/paths/~1api~1v1~1accountCodes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Account Codes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a list of Account Codes."},"children":[]},{"$$mdtype":"Node","type":"hardbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sortBy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to sort results by a supported field and direction."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sortBy","in":"query","schemaId":"schema_243","description":"Sort by field and direction (e.g., code:asc, code:desc)."}],"pointer":"/paths/~1api~1v1~1accountCodes/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-PB-Developer-Partner-ID","in":"header","schemaId":"schema_242","description":"This is the Developer Partner ID. When the developer is the only partner, this field is not required."}],"pointer":"/paths/~1api~1v1~1accountCodes/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/accountCodes","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/costaccountmgmt","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/costaccountmgmt","description":"Production Server (uses live data)"}],"parameters":{"path":[],"query":[{"name":"sortBy","in":"query","example":"code:asc","schemaId":"schema_243"}],"querystring":[],"header":[{"name":"X-PB-Developer-Partner-ID","in":"header","required":false,"schemaId":"schema_242"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/api/v1/accountCodes","href":"account-code/getaccountcodes","openApiOperationId":"getAccountCodes","summary":"Get Account Codes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/costaccountmgmt","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/costaccountmgmt","description":"Production Server (uses live data)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Account Code has been retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_244"}},"schemaId":"schema_244"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"500","description":"The request could not be completed due to an internal error."}],"pointer":"/paths/~1api~1v1~1accountCodes/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_244","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_244"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-code/getaccountcodes"}],"panels":[]}]},"httpPath":"/api/v1/accountCodes"},{"label":"Get Account Code by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/billingcodes/account-code/getaccountcodebyid","routeSlug":"/openapi/billingcodes/account-code/getaccountcodebyid","metadata":{"seo":{"title":"Get Account Code by ID","description":"Retrieves a single Account Code by its unique id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAccountCodeById","name":"Get Account Code by ID","isWebhook":false,"pointer":"/paths/~1api~1v1~1accountCodes~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Account Code by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves a single Account Code by its unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_242","description":"Unique identifier of the Account Code.","required":true}],"pointer":"/paths/~1api~1v1~1accountCodes~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-PB-Developer-Partner-ID","in":"header","schemaId":"schema_242","description":"This is the Developer Partner ID. When the developer is the only partner, this field is not required."}],"pointer":"/paths/~1api~1v1~1accountCodes~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/accountCodes/{id}","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/costaccountmgmt","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/costaccountmgmt","description":"Production Server (uses live data)"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_242"}],"query":[],"querystring":[],"header":[{"name":"X-PB-Developer-Partner-ID","in":"header","required":false,"schemaId":"schema_242"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/api/v1/accountCodes/{id}","href":"account-code/getaccountcodebyid","openApiOperationId":"getAccountCodeById","summary":"Get Account Code by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/costaccountmgmt","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/costaccountmgmt","description":"Production Server (uses live data)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Specified Account Code has been retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountCode"}},"schemaId":"components/schemas/AccountCode"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"500","description":"The request could not be completed due to an internal error."}],"pointer":"/paths/~1api~1v1~1accountCodes~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AccountCode","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountCode"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-code/getaccountcodebyid"}],"panels":[]}]},"httpPath":"/api/v1/accountCodes/{id}"},{"label":"Update Account Code","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/billingcodes/account-code/updateaccountcode","routeSlug":"/openapi/billingcodes/account-code/updateaccountcode","metadata":{"seo":{"title":"Update Account Code","description":"Update the code and/or description for the specified id. Use this to revise an Account Code record."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateAccountCode","name":"Update Account Code","isWebhook":false,"pointer":"/paths/~1api~1v1~1accountCodes~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Account Code","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and/or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"description"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Use this to revise an Account Code record."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_242","description":"Unique identifier of the Account Code.","required":true}],"pointer":"/paths/~1api~1v1~1accountCodes~1{id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-PB-Developer-Partner-ID","in":"header","schemaId":"schema_242","description":"This is the Developer Partner ID. When the developer is the only partner, this field is not required."}],"pointer":"/paths/~1api~1v1~1accountCodes~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateAccountCodeRequest"}},"schemaId":"components/schemas/UpdateAccountCodeRequest","pointer":"/paths/~1api~1v1~1accountCodes~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/v1/accountCodes/{id}","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/costaccountmgmt","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/costaccountmgmt","description":"Production Server (uses live data)"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_242"}],"query":[],"querystring":[],"header":[{"name":"X-PB-Developer-Partner-ID","in":"header","required":false,"schemaId":"schema_242"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateAccountCodeRequest"}},"responseCodes":["200","400","401","500"],"pointer":"/api/v1/accountCodes/{id}","href":"account-code/updateaccountcode","openApiOperationId":"updateAccountCode","summary":"Update Account Code"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/costaccountmgmt","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/costaccountmgmt","description":"Production Server (uses live data)"}],"schemaId":"components/schemas/UpdateAccountCodeRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateAccountCodeRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Specified Account Code has been updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountCodeUpdated"}},"schemaId":"components/schemas/AccountCodeUpdated"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"500","description":"The request could not be completed due to an internal error."}],"pointer":"/paths/~1api~1v1~1accountCodes~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AccountCodeUpdated","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountCodeUpdated"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-code/updateaccountcode"}],"panels":[]}]},"httpPath":"/api/v1/accountCodes/{id}"},{"label":"Delete Account Code","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/billingcodes/account-code/deleteaccountcodebyid","routeSlug":"/openapi/billingcodes/account-code/deleteaccountcodebyid","metadata":{"seo":{"title":"Delete Account Code","description":"Deletes the Account Code identified by id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteAccountCodeById","name":"Delete Account Code","isWebhook":false,"pointer":"/paths/~1api~1v1~1accountCodes~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Account Code","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes the Account Code identified by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_242","description":"Unique identifier of the Account Code.","required":true}],"pointer":"/paths/~1api~1v1~1accountCodes~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-PB-Developer-Partner-ID","in":"header","schemaId":"schema_242","description":"This is the Developer Partner ID. When the developer is the only partner, this field is not required."}],"pointer":"/paths/~1api~1v1~1accountCodes~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v1/accountCodes/{id}","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/costaccountmgmt","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/costaccountmgmt","description":"Production Server (uses live data)"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_242"}],"query":[],"querystring":[],"header":[{"name":"X-PB-Developer-Partner-ID","in":"header","required":false,"schemaId":"schema_242"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/api/v1/accountCodes/{id}","href":"account-code/deleteaccountcodebyid","openApiOperationId":"deleteAccountCodeById","summary":"Delete Account Code"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/costaccountmgmt","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/costaccountmgmt","description":"Production Server (uses live data)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Specified Account Code has been deleted successfully."},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1api~1v1~1accountCodes~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/account-code/deleteaccountcodebyid"}],"panels":[]}]},"httpPath":"/api/v1/accountCodes/{id}"}],"content":{"contentType":"group","meta":{"name":"Account Code"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Account Code","showPageActions":true},{"nodeType":"markdoc","content":"APIs for managing account codes."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/accountCodes","summary":"Create Account Code","prefix":{"name":"post","color":"post"},"badges":[],"link":"/account-code/createaccountcode","deprecated":false},{"title":"/api/v1/accountCodes","summary":"Get Account Codes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/account-code/getaccountcodes","deprecated":false},{"title":"/api/v1/accountCodes/{id}","summary":"Get Account Code by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/account-code/getaccountcodebyid","deprecated":false},{"title":"/api/v1/accountCodes/{id}","summary":"Update Account Code","prefix":{"name":"put","color":"put"},"badges":[],"link":"/account-code/updateaccountcode","deprecated":false},{"title":"/api/v1/accountCodes/{id}","summary":"Delete Account Code","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/account-code/deleteaccountcodebyid","deprecated":false}]}]}]}]}},{"type":"group","label":"Company Code","link":"/openapi/billingcodes/company-code","routeSlug":"/openapi/billingcodes/company-code","items":[{"label":"Create Company Code","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/billingcodes/company-code/createcompanycode","routeSlug":"/openapi/billingcodes/company-code/createcompanycode","metadata":{"seo":{"title":"Create Company Code","description":"Creates a new Company Code record. The code must be unique per tenant."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createCompanyCode","name":"Create Company Code","isWebhook":false,"pointer":"/paths/~1api~1v1~1companyCodes/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Company Code","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a new Company Code record. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be unique per tenant."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-PB-Developer-Partner-ID","in":"header","schemaId":"schema_242","description":"Developer Partner ID. Not required if the developer is the only partner."}],"pointer":"/paths/~1api~1v1~1companyCodes/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateCompanyCodeRequest"}},"schemaId":"components/schemas/CreateCompanyCodeRequest","pointer":"/paths/~1api~1v1~1companyCodes/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/companyCodes","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/costaccountmgmt","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/costaccountmgmt","description":"Production Server (uses live data)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-PB-Developer-Partner-ID","in":"header","required":false,"schemaId":"schema_242"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateCompanyCodeRequest"}},"responseCodes":["201","400","401","500"],"pointer":"/api/v1/companyCodes","href":"company-code/createcompanycode","openApiOperationId":"createCompanyCode","summary":"Create Company Code"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/costaccountmgmt","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/costaccountmgmt","description":"Production Server (uses live data)"}],"schemaId":"components/schemas/CreateCompanyCodeRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateCompanyCodeRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Company Code has been created successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanyCodeCreated"}},"schemaId":"components/schemas/CompanyCodeCreated"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"500","description":"The request could not be completed due to an internal error."}],"pointer":"/paths/~1api~1v1~1companyCodes/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/CompanyCodeCreated","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanyCodeCreated"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/company-code/createcompanycode"}],"panels":[]}]},"httpPath":"/api/v1/companyCodes"},{"label":"Get Company Codes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/billingcodes/company-code/getcompanycodes","routeSlug":"/openapi/billingcodes/company-code/getcompanycodes","metadata":{"seo":{"title":"Get Company Codes","description":"Returns a list of Company Codes."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCompanyCodes","name":"Get Company Codes","isWebhook":false,"pointer":"/paths/~1api~1v1~1companyCodes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Company Codes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of Company Codes.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-PB-Developer-Partner-ID","in":"header","schemaId":"schema_242","description":"Developer Partner ID. Not required if the developer is the only partner."}],"pointer":"/paths/~1api~1v1~1companyCodes/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/companyCodes","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/costaccountmgmt","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/costaccountmgmt","description":"Production Server (uses live data)"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-PB-Developer-Partner-ID","in":"header","required":false,"schemaId":"schema_242"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/api/v1/companyCodes","href":"company-code/getcompanycodes","openApiOperationId":"getCompanyCodes","summary":"Get Company Codes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/costaccountmgmt","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/costaccountmgmt","description":"Production Server (uses live data)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of Company Codes has been retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_245"}},"schemaId":"schema_245"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"500","description":"The request could not be completed due to an internal error."}],"pointer":"/paths/~1api~1v1~1companyCodes/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_245","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_245"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/company-code/getcompanycodes"}],"panels":[]}]},"httpPath":"/api/v1/companyCodes"},{"label":"Get Company Code by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/billingcodes/company-code/getcompanycodebyid","routeSlug":"/openapi/billingcodes/company-code/getcompanycodebyid","metadata":{"seo":{"title":"Get Company Code by ID","description":"Retrieves a single Company Code by its unique id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCompanyCodeById","name":"Get Company Code by ID","isWebhook":false,"pointer":"/paths/~1api~1v1~1companyCodes~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Company Code by ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves a single Company Code by its unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_242","description":"Unique identifier of the Company Code.","required":true}],"pointer":"/paths/~1api~1v1~1companyCodes~1{id}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-PB-Developer-Partner-ID","in":"header","schemaId":"schema_242","description":"Developer Partner ID. Not required if the developer is the only partner."}],"pointer":"/paths/~1api~1v1~1companyCodes~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/companyCodes/{id}","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/costaccountmgmt","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/costaccountmgmt","description":"Production Server (uses live data)"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_242"}],"query":[],"querystring":[],"header":[{"name":"X-PB-Developer-Partner-ID","in":"header","required":false,"schemaId":"schema_242"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/api/v1/companyCodes/{id}","href":"company-code/getcompanycodebyid","openApiOperationId":"getCompanyCodeById","summary":"Get Company Code by ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/costaccountmgmt","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/costaccountmgmt","description":"Production Server (uses live data)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Specified Company Code has been retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanyCode"}},"schemaId":"components/schemas/CompanyCode"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"500","description":"The request could not be completed due to an internal error."}],"pointer":"/paths/~1api~1v1~1companyCodes~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CompanyCode","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanyCode"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/company-code/getcompanycodebyid"}],"panels":[]}]},"httpPath":"/api/v1/companyCodes/{id}"},{"label":"Update Company Code","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/billingcodes/company-code/updatecompanycode","routeSlug":"/openapi/billingcodes/company-code/updatecompanycode","metadata":{"seo":{"title":"Update Company Code","description":"Update the code and/or description for the specified id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateCompanyCode","name":"Update Company Code","isWebhook":false,"pointer":"/paths/~1api~1v1~1companyCodes~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Company Code","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and/or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"description"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_242","description":"Unique identifier of the Company Code.","required":true}],"pointer":"/paths/~1api~1v1~1companyCodes~1{id}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-PB-Developer-Partner-ID","in":"header","schemaId":"schema_242","description":"Developer Partner ID. Not required if the developer is the only partner."}],"pointer":"/paths/~1api~1v1~1companyCodes~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateCompanyCodeRequest"}},"schemaId":"components/schemas/UpdateCompanyCodeRequest","pointer":"/paths/~1api~1v1~1companyCodes~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/v1/companyCodes/{id}","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/costaccountmgmt","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/costaccountmgmt","description":"Production Server (uses live data)"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_242"}],"query":[],"querystring":[],"header":[{"name":"X-PB-Developer-Partner-ID","in":"header","required":false,"schemaId":"schema_242"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateCompanyCodeRequest"}},"responseCodes":["200","400","401","500"],"pointer":"/api/v1/companyCodes/{id}","href":"company-code/updatecompanycode","openApiOperationId":"updateCompanyCode","summary":"Update Company Code"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/costaccountmgmt","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/costaccountmgmt","description":"Production Server (uses live data)"}],"schemaId":"components/schemas/UpdateCompanyCodeRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateCompanyCodeRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Specified Company Code has been updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanyCodeUpdated"}},"schemaId":"components/schemas/CompanyCodeUpdated"},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"500","description":"The request could not be completed due to an internal error."}],"pointer":"/paths/~1api~1v1~1companyCodes~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CompanyCodeUpdated","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CompanyCodeUpdated"}}},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/company-code/updatecompanycode"}],"panels":[]}]},"httpPath":"/api/v1/companyCodes/{id}"},{"label":"Delete Company Code","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/billingcodes/company-code/deletecompanycodebyid","routeSlug":"/openapi/billingcodes/company-code/deletecompanycodebyid","metadata":{"seo":{"title":"Delete Company Code","description":"Deletes the Company Code identified by id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteCompanyCodeById","name":"Delete Company Code","isWebhook":false,"pointer":"/paths/~1api~1v1~1companyCodes~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Company Code","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes the Company Code identified by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_242","description":"Unique identifier of the Company Code.","required":true}],"pointer":"/paths/~1api~1v1~1companyCodes~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-PB-Developer-Partner-ID","in":"header","schemaId":"schema_242","description":"Developer Partner ID. Not required if the developer is the only partner."}],"pointer":"/paths/~1api~1v1~1companyCodes~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v1/companyCodes/{id}","servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/costaccountmgmt","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/costaccountmgmt","description":"Production Server (uses live data)"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_242"}],"query":[],"querystring":[],"header":[{"name":"X-PB-Developer-Partner-ID","in":"header","required":false,"schemaId":"schema_242"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","400","401","500"],"pointer":"/api/v1/companyCodes/{id}","href":"company-code/deletecompanycodebyid","openApiOperationId":"deleteCompanyCodeById","summary":"Delete Company Code"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/costaccountmgmt","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/costaccountmgmt","description":"Production Server (uses live data)"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Specified Company Code has been deleted successfully."},{"code":"400","description":"Invalid request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}},"schemaId":"components/schemas/Errors"},{"code":"401","description":"The request could not be authorized.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"500","description":"The request could not be completed due to an internal error."}],"pointer":"/paths/~1api~1v1~1companyCodes~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"components/schemas/Errors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Errors"}}},{"code":"401","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/company-code/deletecompanycodebyid"}],"panels":[]}]},"httpPath":"/api/v1/companyCodes/{id}"}],"content":{"contentType":"group","meta":{"name":"Company Code"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Company Code","showPageActions":true},{"nodeType":"markdoc","content":"APIs for managing company codes."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/companyCodes","summary":"Create Company Code","prefix":{"name":"post","color":"post"},"badges":[],"link":"/company-code/createcompanycode","deprecated":false},{"title":"/api/v1/companyCodes","summary":"Get Company Codes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/company-code/getcompanycodes","deprecated":false},{"title":"/api/v1/companyCodes/{id}","summary":"Get Company Code by ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/company-code/getcompanycodebyid","deprecated":false},{"title":"/api/v1/companyCodes/{id}","summary":"Update Company Code","prefix":{"name":"put","color":"put"},"badges":[],"link":"/company-code/updatecompanycode","deprecated":false},{"title":"/api/v1/companyCodes/{id}","summary":"Delete Company Code","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/company-code/deletecompanycodebyid","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/error":{"id":"components/schemas/error","kind":"json-schema","title":"error","data":{"type":"object","properties":{"message":{"type":"string","description":"This is HTTP 401 Unauthorized response status code, that indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource."}},"required":["message"]}},"components/schemas/Errors":{"id":"components/schemas/Errors","kind":"json-schema","title":"Errors","data":{"type":"object","properties":{"errors":{"type":"array","description":"List of errors.","items":{"type":"object","properties":{"errorCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This error can be validation_error or internal_error or not_found or already_exists"},"children":[]}]}]}],"example":"validation_error"},"errorDescription":{"type":"string","description":"The HTTP 400 Bad Request response status code indicates that the server cannot process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).","example":"Custom Fields not found"}}}}}}},"components/schemas/CreateAccountCodeRequest":{"id":"components/schemas/CreateAccountCodeRequest","kind":"json-schema","title":"CreateAccountCodeRequest","data":{"type":"object","required":["code"],"description":"Request body for creating an Account Code.","properties":{"code":{"type":"string","description":"Customer-defined Account Code value (must be unique per tenant).","example":"278001"},"description":{"type":"string","description":"Human-readable description for the Account Code.","example":"this is description for test code 278001"}}}},"components/schemas/UpdateAccountCodeRequest":{"id":"components/schemas/UpdateAccountCodeRequest","kind":"json-schema","title":"UpdateAccountCodeRequest","data":{"type":"object","description":"Request body to update an Account Code.","properties":{"code":{"type":"string","description":"New/updated Account Code value.","example":"278001"},"description":{"type":"string","description":"Updated description of the Account Code.","example":"this is description for test codehash278001-u1"}}}},"components/schemas/AccountCodeCreated":{"id":"components/schemas/AccountCodeCreated","kind":"json-schema","title":"AccountCodeCreated","data":{"type":"object","description":"Response payload returned after creating an Account Code.","properties":{"id":{"type":"string","description":"System-generated identifier of the created Account Code.","example":"d8WpwWzlMgYO"}}}},"components/schemas/AccountCodeUpdated":{"id":"components/schemas/AccountCodeUpdated","kind":"json-schema","title":"AccountCodeUpdated","data":{"type":"object","description":"Response payload returned after updating an Account Code.","properties":{"id":{"type":"string","description":"Identifier of the updated Account Code.","example":"d8WpwWzlMgYO"}}}},"components/schemas/AccountCode":{"id":"components/schemas/AccountCode","kind":"json-schema","title":"AccountCode","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the Account Code created by system.","example":"d8WpwWzlMgYO"},"code":{"type":"string","description":"This is unique Account Code.","example":"280002"},"description":{"type":"string","description":"Account Code description.","example":"this is description for test codehash280002"}}}},"components/schemas/AccountCodeListItem":{"id":"components/schemas/AccountCodeListItem","kind":"json-schema","title":"AccountCodeListItem","data":{"type":"object","description":"Account Code record returned by the system.","properties":{"id":{"type":"string","description":"Unique identifier of the Account Code created by system.","example":"da5l9bkOMml5"},"code":{"type":"string","description":"Unique Account Code value.","example":"278001"},"description":{"type":"string","description":"Account Code description.","example":"This is description for test codehash278001-u1"}}}},"components/schemas/CreateCompanyCodeRequest":{"id":"components/schemas/CreateCompanyCodeRequest","kind":"json-schema","title":"CreateCompanyCodeRequest","data":{"type":"object","required":["code"],"description":"Request body for creating a Company Code.","properties":{"code":{"type":"string","description":"Customer-defined Company Code value (must be unique per tenant).","example":"COMP001"},"description":{"type":"string","description":"Human-readable description for the Company Code.","example":"This is description for test company code COMP001"}}}},"components/schemas/UpdateCompanyCodeRequest":{"id":"components/schemas/UpdateCompanyCodeRequest","kind":"json-schema","title":"UpdateCompanyCodeRequest","data":{"type":"object","description":"Request body to update a Company Code.","properties":{"code":{"type":"string","description":"New or updated Company Code value.","example":"COMP001"},"description":{"type":"string","description":"Updated description of the Company Code.","example":"This is description for updated company code COMP001-u1"}}}},"components/schemas/CompanyCodeCreated":{"id":"components/schemas/CompanyCodeCreated","kind":"json-schema","title":"CompanyCodeCreated","data":{"type":"object","description":"Response payload returned after creating a Company Code.","properties":{"id":{"type":"string","description":"System-generated identifier of the created Company Code.","example":"cmpy12345xyz"}}}},"components/schemas/CompanyCodeUpdated":{"id":"components/schemas/CompanyCodeUpdated","kind":"json-schema","title":"CompanyCodeUpdated","data":{"type":"object","description":"Response payload returned after updating a Company Code.","properties":{"id":{"type":"string","description":"Identifier of the updated Company Code.","example":"cmpy12345xyz"}}}},"components/schemas/CompanyCode":{"id":"components/schemas/CompanyCode","kind":"json-schema","title":"CompanyCode","data":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the Company Code created by the system.","example":"cmpy12345xyz"},"code":{"type":"string","description":"Unique Company Code value.","example":"COMP002"},"description":{"type":"string","description":"Description of the Company Code.","example":"This is description for test company code COMP002"}}}},"components/schemas/CompanyCodeListItem":{"id":"components/schemas/CompanyCodeListItem","kind":"json-schema","title":"CompanyCodeListItem","data":{"type":"object","description":"Company Code record returned by the system.","properties":{"id":{"type":"string","description":"Unique identifier of the Company Code created by the system.","example":"cmpy6789abc"},"code":{"type":"string","description":"Unique Company Code value.","example":"COMP001"},"description":{"type":"string","description":"Company Code description.","example":"This is description for updated company code COMP001-u1"}}}},"schema_242":{"kind":"json-schema","data":{"type":"string"},"id":"schema_242"},"schema_243":{"kind":"json-schema","data":{"type":"string","example":"code:asc"},"id":"schema_243"},"schema_244":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/AccountCodeListItem"}},"id":"schema_244"},"schema_245":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/CompanyCodeListItem"}},"id":"schema_245"}},"exampleStore":{},"securitySchemeStore":{"bearerAuth":{"id":"bearerAuth","type":"http","scheme":"bearer"}},"servers":[{"url":"https://api-sandbox.sendpro360.pitneybowes.com/costaccountmgmt","description":"Sandbox Server"},{"url":"https://api.sendpro360.pitneybowes.com/costaccountmgmt","description":"Production Server (uses live data)"}]},"options":{"hideDownloadButtons":false,"hideInfoMetadata":true,"jsonSamplesExpandLevel":3,"layout":"three-panel","schemasExpansionLevel":2,"generateCodeSamples":{"languages":[{"lang":"curl"},{"lang":"JavaScript"},{"lang":"Node.js"},{"lang":"Python"},{"lang":"Go"},{"lang":"Java"},{"lang":"C#"}]},"hideSidebar":true,"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/openapi/billingcodes.json?download"},{"url":"/_bundle/openapi/billingcodes.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Overview","description":"CRUD operations to manage **billing codes** and **company codes**.\nA billing code is a customer-defined identifier (e.g., an account or company) that can be attached to shipments, invoices, or reports.\n"}},"baseSlug":"/openapi/billingcodes","routesMapping":{}}