{"items":[{"type":"link","label":"Cost Account APIs","link":"/openapi/costaccount","routeSlug":"/openapi/costaccount","content":{"contentType":"overview","meta":{"name":"Cost Account APIs"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"costaccount.json","url":"/_bundle/openapi/costaccount.json?download"},{"kind":"download","label":"costaccount.yaml","url":"/_bundle/openapi/costaccount.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"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":"Cost Account APIs (1.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"These APIs provides Cost Account management operations like creating Cost account, modify, get and delete."}],"sectionId":"/openapi/costaccount"}],"sectionId":"/openapi/costaccount"}]}]}},{"type":"group","label":"Cost Account Management","link":"/openapi/costaccount/cost-account-management","routeSlug":"/openapi/costaccount/cost-account-management","items":[{"label":"Add Cost Account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/costaccount/cost-account-management/addcostaccount","routeSlug":"/openapi/costaccount/cost-account-management/addcostaccount","metadata":{"seo":{"title":"Add Cost Account","description":"This operation creates cost account. "}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"addCostAccount","name":"Add Cost Account","isWebhook":false,"pointer":"/paths/~1api~1v1~1costAccounts/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add Cost Account","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":"This operation creates cost account. "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Key Considerations:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A cost account is an account used to maintain and segregate records for shipments, postage, and other operational data. There can be multiple Cost accounts, I.e; multiple Wallet - but one ledger."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cost accounts allow to track which wallet was used for payment, maintain detailed payment history, and set budget notifications or thresholds."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cost accounts are managed in a hierarchical structure: Enterprise > Division > Location."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cost accounts can be assigned to a location, enabling client administrators to filter and analyze records based on the selected cost account."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A location can have one or more cost accounts assigned to it. This allows to filter shipments or postage records by selecting the cost account."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cost accounts are assigned a status of either Active or Inactive."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sub-Cost Accounts and Sub-Sub-Cost Accounts can also be created under the main cost account to further refine segregation."},"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_248","description":"This is the Developer Partner ID. When the developer is the only partner, this field is not required."}],"pointer":"/paths/~1api~1v1~1costAccounts/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CostAccountRequest"}},"schemaId":"components/schemas/CostAccountRequest","pointer":"/paths/~1api~1v1~1costAccounts/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/costAccounts","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_248"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CostAccountRequest"}},"responseCodes":["200","401"],"pointer":"/api/v1/costAccounts","href":"cost-account-management/addcostaccount","openApiOperationId":"addCostAccount","summary":"Add Cost Account"},"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/CostAccountRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CostAccountRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Cost Account Added Successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CostAccountResponse"}},"schemaId":"components/schemas/CostAccountResponse"},{"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"}],"pointer":"/paths/~1api~1v1~1costAccounts/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CostAccountResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CostAccountResponse"}}},{"code":"401","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cost-account-management/addcostaccount"}],"panels":[]}]},"httpPath":"/api/v1/costAccounts"},{"label":"Get Cost Accounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/costaccount/cost-account-management/getcostaccounts","routeSlug":"/openapi/costaccount/cost-account-management/getcostaccounts","metadata":{"seo":{"title":"Get Cost Accounts","description":"This operation gets cost account details"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCostAccounts","name":"Get Cost Accounts","isWebhook":false,"pointer":"/paths/~1api~1v1~1costAccounts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Cost Accounts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This operation gets cost account details"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_248","description":"This indicates the page of the Cost account result list.","example":"1"},{"name":"size","in":"query","schemaId":"schema_248","description":"This indicates the size/count of the searched result list.","example":"10"}],"pointer":"/paths/~1api~1v1~1costAccounts/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-PB-Developer-Partner-ID","in":"header","schemaId":"schema_248","description":"This is the Developer Partner ID. When the developer is the only partner, this field is not required.","example":""}],"pointer":"/paths/~1api~1v1~1costAccounts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/costAccounts","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":"page","in":"query","example":"1","schemaId":"schema_248"},{"name":"size","in":"query","example":"10","schemaId":"schema_248"}],"querystring":[],"header":[{"name":"X-PB-Developer-Partner-ID","in":"header","required":false,"example":"","schemaId":"schema_248"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/api/v1/costAccounts","href":"cost-account-management/getcostaccounts","openApiOperationId":"getCostAccounts","summary":"Get Cost Accounts"},"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":"Cost Accounts Fetched Successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetCostAccountsResponse"}},"schemaId":"components/schemas/GetCostAccountsResponse"},{"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"}],"pointer":"/paths/~1api~1v1~1costAccounts/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetCostAccountsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetCostAccountsResponse"}}},{"code":"401","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cost-account-management/getcostaccounts"}],"panels":[]}]},"httpPath":"/api/v1/costAccounts"},{"label":"Update Cost Account","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/costaccount/cost-account-management/updatecostaccount","routeSlug":"/openapi/costaccount/cost-account-management/updatecostaccount","metadata":{"seo":{"title":"Update Cost Account","description":"Update Cost Account"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateCostAccount","name":"Update Cost Account","isWebhook":false,"pointer":"/paths/~1api~1v1~1costAccounts~1{costaccountId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Cost Account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update Cost Account"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"costaccountId","in":"path","schemaId":"schema_248","required":true}],"pointer":"/paths/~1api~1v1~1costAccounts~1{costaccountId}/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-PB-Developer-Partner-ID","in":"header","schemaId":"schema_248","description":"This is the Developer Partner ID. When the developer is the only partner, this field is not required."}],"pointer":"/paths/~1api~1v1~1costAccounts~1{costaccountId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateCostAccount"}},"schemaId":"components/schemas/UpdateCostAccount","pointer":"/paths/~1api~1v1~1costAccounts~1{costaccountId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/api/v1/costAccounts/{costaccountId}","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":"costaccountId","in":"path","required":true,"schemaId":"schema_248"}],"query":[],"querystring":[],"header":[{"name":"X-PB-Developer-Partner-ID","in":"header","required":false,"schemaId":"schema_248"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateCostAccount"}},"responseCodes":["200","401"],"pointer":"/api/v1/costAccounts/{costaccountId}","href":"cost-account-management/updatecostaccount","openApiOperationId":"updateCostAccount","summary":"Update Cost Account"},"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/UpdateCostAccount","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateCostAccount"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Specified cost account updated successfully."},{"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"}],"pointer":"/paths/~1api~1v1~1costAccounts~1{costaccountId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"401","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cost-account-management/updatecostaccount"}],"panels":[]}]},"httpPath":"/api/v1/costAccounts/{costaccountId}"},{"label":"Get Cost Account Details by Cost Account ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/costaccount/cost-account-management/getcostaccount","routeSlug":"/openapi/costaccount/cost-account-management/getcostaccount","metadata":{"seo":{"title":"Get Cost Account Details by Cost Account ID","description":"This operation gets the Cost account by cost account ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCostAccount","name":"Get Cost Account Details by Cost Account ID","isWebhook":false,"pointer":"/paths/~1api~1v1~1costAccounts~1{costaccountId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Cost Account Details by Cost Account ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This operation gets the Cost account by cost account ID"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"costaccountId","in":"path","schemaId":"schema_248","description":"Indicates costaccountId.","required":true}],"pointer":"/paths/~1api~1v1~1costAccounts~1{costaccountId}/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-PB-Developer-Partner-ID","in":"header","schemaId":"schema_248","description":"This is the Developer Partner ID. When the developer is the only partner, this field is not required."}],"pointer":"/paths/~1api~1v1~1costAccounts~1{costaccountId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/costAccounts/{costaccountId}","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":"costaccountId","in":"path","required":true,"schemaId":"schema_248"}],"query":[],"querystring":[],"header":[{"name":"X-PB-Developer-Partner-ID","in":"header","required":false,"schemaId":"schema_248"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/api/v1/costAccounts/{costaccountId}","href":"cost-account-management/getcostaccount","openApiOperationId":"getCostAccount","summary":"Get Cost Account Details by Cost Account 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":"Cost Account get successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetCostAccountResponse"}},"schemaId":"components/schemas/GetCostAccountResponse"},{"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"}],"pointer":"/paths/~1api~1v1~1costAccounts~1{costaccountId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetCostAccountResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetCostAccountResponse"}}},{"code":"401","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cost-account-management/getcostaccount"}],"panels":[]}]},"httpPath":"/api/v1/costAccounts/{costaccountId}"},{"label":"Delete Cost Account","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/costaccount/cost-account-management/deletecostaccount","routeSlug":"/openapi/costaccount/cost-account-management/deletecostaccount","metadata":{"seo":{"title":"Delete Cost Account","description":"This operation archive the cost account"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteCostAccount","name":"Delete Cost Account","isWebhook":false,"pointer":"/paths/~1api~1v1~1costAccounts~1{costaccountId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Cost Account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This operation archive the cost account"},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"costaccountId","in":"path","schemaId":"schema_248","description":"Indicates CostAccountID.","required":true}],"pointer":"/paths/~1api~1v1~1costAccounts~1{costaccountId}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-PB-Developer-Partner-ID","in":"header","schemaId":"schema_248","description":"This is the Developer Partner ID. When the developer is the only partner, this field is not required."}],"pointer":"/paths/~1api~1v1~1costAccounts~1{costaccountId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/api/v1/costAccounts/{costaccountId}","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":"costaccountId","in":"path","required":true,"schemaId":"schema_248"}],"query":[],"querystring":[],"header":[{"name":"X-PB-Developer-Partner-ID","in":"header","required":false,"schemaId":"schema_248"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/api/v1/costAccounts/{costaccountId}","href":"cost-account-management/deletecostaccount","openApiOperationId":"deleteCostAccount","summary":"Delete Cost Account"},"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":"Cost Account Archived successful"},{"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"}],"pointer":"/paths/~1api~1v1~1costAccounts~1{costaccountId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"401","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cost-account-management/deletecostaccount"}],"panels":[]}]},"httpPath":"/api/v1/costAccounts/{costaccountId}"},{"label":"Create Cost Account Import Job","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/costaccount/cost-account-management/importcostaccount","routeSlug":"/openapi/costaccount/cost-account-management/importcostaccount","metadata":{"seo":{"title":"Create Cost Account Import Job","description":"This operation is used for creating a job for Cost Accounts Import. The payload for this endpoint is an empty JSON object {} because it does not require any additional data to be sent in the request body. jobID and url is returned in the response where user can upload csv file containing cost accounts. Download the sample-cost-accounts-import file."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"importCostAccount","name":"Create Cost Account Import Job","isWebhook":false,"pointer":"/paths/~1api~1v1~1costAccounts~1importUrl/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Cost Account Import Job","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":"This operation is used for creating a job for Cost Accounts Import. The payload for this endpoint is an empty JSON object {} because it does not require any additional data to be sent in the request body. jobID and url is returned in the response where user can upload csv file containing cost accounts. Download the sample-cost-accounts-import file."},"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_248","description":"This is the Developer Partner ID. When the developer is the only partner, this field is not required."}],"pointer":"/paths/~1api~1v1~1costAccounts~1importUrl/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/costAccounts/importUrl","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_248"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/api/v1/costAccounts/importUrl","href":"cost-account-management/importcostaccount","openApiOperationId":"importCostAccount","summary":"Create Cost Account Import Job"},"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":"Cost Account Added Successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ImportCostAccountResponse"}},"schemaId":"components/schemas/ImportCostAccountResponse"},{"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"}],"pointer":"/paths/~1api~1v1~1costAccounts~1importUrl/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ImportCostAccountResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ImportCostAccountResponse"}}},{"code":"401","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cost-account-management/importcostaccount"}],"panels":[]}]},"httpPath":"/api/v1/costAccounts/importUrl"},{"label":"Process Import Cost Account Job","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/costaccount/cost-account-management/processimportcostaccount","routeSlug":"/openapi/costaccount/cost-account-management/processimportcostaccount","metadata":{"seo":{"title":"Process Import Cost Account Job","description":"This operation processes (executes) the existing Batch job. The {jobID} path parameter is required to identify which batch job to process. The payload for this endpoint is an empty JSON object {} because it does not require any additional data to be sent in the request body. Once the job is processed, system will read the uploaded csv file, validate the data and create cost accounts based on that. In case of any error in the file, cost account will not be created and error csv file will be generated for details of error.The payload for this endpoint is an empty JSON object {} because it does not require any additional data to be sent in the request body. The jobId parameter in the endpoint URL specifies which batch of shipments to process."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"processImportCostAccount","name":"Process Import Cost Account Job","isWebhook":false,"pointer":"/paths/~1api~1v1~1costAccounts~1batch~1{jobID}~1process/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Process Import Cost Account Job","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":"This operation processes (executes) the existing Batch job. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{jobID}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" path parameter is required to identify which batch job to process. The payload for this endpoint is an empty JSON object {} because it does not require any additional data to be sent in the request body. Once the job is processed, system will read the uploaded csv file, validate the data and create cost accounts based on that. In case of any error in the file, cost account will not be created and error csv file will be generated for details of error."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The payload for this endpoint is an empty JSON object {} because it does not require any additional data to be sent in the request body. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"jobId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter in the endpoint URL specifies which batch of shipments to process."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"jobID","in":"path","schemaId":"schema_248","description":"A unique identifier assigned to job which is automatically assigned by system while it is processed.","required":true}],"pointer":"/paths/~1api~1v1~1costAccounts~1batch~1{jobID}~1process/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-PB-Developer-Partner-ID","in":"header","schemaId":"schema_248","description":"This is the Developer Partner ID. When the developer is the only partner, this field is not required."}],"pointer":"/paths/~1api~1v1~1costAccounts~1batch~1{jobID}~1process/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/v1/costAccounts/batch/{jobID}/process","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":"jobID","in":"path","required":true,"schemaId":"schema_248"}],"query":[],"querystring":[],"header":[{"name":"X-PB-Developer-Partner-ID","in":"header","required":false,"schemaId":"schema_248"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/api/v1/costAccounts/batch/{jobID}/process","href":"cost-account-management/processimportcostaccount","openApiOperationId":"processImportCostAccount","summary":"Process Import Cost Account Job"},"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":"Process Import cost Account","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProcessImportCostAccountResponse"}},"schemaId":"components/schemas/ProcessImportCostAccountResponse"},{"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"}],"pointer":"/paths/~1api~1v1~1costAccounts~1batch~1{jobID}~1process/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProcessImportCostAccountResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProcessImportCostAccountResponse"}}},{"code":"401","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cost-account-management/processimportcostaccount"}],"panels":[]}]},"httpPath":"/api/v1/costAccounts/batch/{jobID}/process"},{"label":"Get Import Cost Account Job Status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/costaccount/cost-account-management/importcostaccountstatus","routeSlug":"/openapi/costaccount/cost-account-management/importcostaccountstatus","metadata":{"seo":{"title":"Get Import Cost Account Job Status","description":"This operation retrieves the status of an existing Batch identified by {jobID}. The response will provide information about its current status and whether the job has been completed. In case of error, an error CSV file will be generated with details of the error."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"importCostAccountStatus","name":"Get Import Cost Account Job Status","isWebhook":false,"pointer":"/paths/~1api~1v1~1costAccounts~1batch~1{jobID}~1status/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Import Cost Account Job Status","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":"This operation retrieves the status of an existing Batch identified by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{jobID}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The response will provide information about its current status and whether the job has been completed. In case of error, an error CSV file will be generated with details of the error."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"jobID","in":"path","schemaId":"schema_248","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is the jobID which system generated in response of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Import Cost Account"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" API"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1api~1v1~1costAccounts~1batch~1{jobID}~1status/get/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-PB-Developer-Partner-ID","in":"header","schemaId":"schema_248","description":"This is the Developer Partner ID. When the developer is the only partner, this field is not required."}],"pointer":"/paths/~1api~1v1~1costAccounts~1batch~1{jobID}~1status/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/v1/costAccounts/batch/{jobID}/status","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":"jobID","in":"path","required":true,"schemaId":"schema_248"}],"query":[],"querystring":[],"header":[{"name":"X-PB-Developer-Partner-ID","in":"header","required":false,"schemaId":"schema_248"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/api/v1/costAccounts/batch/{jobID}/status","href":"cost-account-management/importcostaccountstatus","openApiOperationId":"importCostAccountStatus","summary":"Get Import Cost Account Job Status"},"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":"Cost Account Added Successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ImportCostAccountStatusResponse"}},"schemaId":"components/schemas/ImportCostAccountStatusResponse"},{"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"}],"pointer":"/paths/~1api~1v1~1costAccounts~1batch~1{jobID}~1status/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ImportCostAccountStatusResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ImportCostAccountStatusResponse"}}},{"code":"401","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cost-account-management/importcostaccountstatus"}],"panels":[]}]},"httpPath":"/api/v1/costAccounts/batch/{jobID}/status"}],"content":{"contentType":"group","meta":{"name":"Cost Account Management"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cost Account Management","showPageActions":true},{"nodeType":"markdoc","content":"APIs provide facility to create and manage cost accounts."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/v1/costAccounts","summary":"Add Cost Account","prefix":{"name":"post","color":"post"},"badges":[],"link":"/cost-account-management/addcostaccount","deprecated":false},{"title":"/api/v1/costAccounts","summary":"Get Cost Accounts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/cost-account-management/getcostaccounts","deprecated":false},{"title":"/api/v1/costAccounts/{costaccountId}","summary":"Update Cost Account","prefix":{"name":"put","color":"put"},"badges":[],"link":"/cost-account-management/updatecostaccount","deprecated":false},{"title":"/api/v1/costAccounts/{costaccountId}","summary":"Get Cost Account Details by Cost Account ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/cost-account-management/getcostaccount","deprecated":false},{"title":"/api/v1/costAccounts/{costaccountId}","summary":"Delete Cost Account","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/cost-account-management/deletecostaccount","deprecated":false},{"title":"/api/v1/costAccounts/importUrl","summary":"Create Cost Account Import Job","prefix":{"name":"post","color":"post"},"badges":[],"link":"/cost-account-management/importcostaccount","deprecated":false},{"title":"/api/v1/costAccounts/batch/{jobID}/process","summary":"Process Import Cost Account Job","prefix":{"name":"post","color":"post"},"badges":[],"link":"/cost-account-management/processimportcostaccount","deprecated":false},{"title":"/api/v1/costAccounts/batch/{jobID}/status","summary":"Get Import Cost Account Job Status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/cost-account-management/importcostaccountstatus","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/CostAccountRequest":{"id":"components/schemas/CostAccountRequest","kind":"json-schema","title":"CostAccountRequest","data":{"type":"object","required":["name","code"],"properties":{"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Name of the cost account. When used in Shipment APIs, this field is referred to as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"costAccountName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"testname"},"code":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Code of the cost account. When used in Shipment APIs, this field is referred to as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"costAccountCode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"test01"},"passwordEnabled":{"type":"boolean","description":"Set to true when to enable password on cost account","example":true},"passwordCode":{"type":"string","description":"Only required when passwordEnabled is true. this indicates the password you want to set. It should be alphanumeric and lenght of 4","example":"test"},"description":{"type":"string","description":"this indicates the description you want to provide for cost account","example":"test cost account"},"status":{"type":"boolean","description":"Setting  true creates cost account as Active and setting false makes it inactive","example":true},"billable":{"type":"boolean","description":"set to true in case want to make cost account billable","example":true},"parent":{"type":"string","description":"this indicates cost account Id of parent account","example":""},"advanceOption":{"type":"object","description":"Additional configuration options for assigning the cost account to a specific  hierarchy level (Enterprise, Division, or Location). If no permission is provided, the cost account is assigned to the Enterprise level by default.","properties":{"permission":{"type":"object","description":"Defines the hierarchy level and corresponding entity values where this cost account will be available.","properties":{"permissionByEntity":{"type":"string","description":"Indicates the hierarchy level at which the cost account is assigned.\nSupported values:\n","enum":["D","L","E"]},"permissionByValue":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The list of identifiers corresponding to the selected hierarchy level."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Division IDs if permissionByEntity = D "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Location IDs if permissionByEntity = L "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enterprise ID f permissionByEntity = E"},"children":[]}]}]}],"items":{"type":"string"}}}}},"example":{"permission":{"permissionByEntity":"D","permissionByValue":["div_auto_sac11be"]}}}}}},"components/schemas/GetCostAccountResponse":{"id":"components/schemas/GetCostAccountResponse","kind":"json-schema","title":"GetCostAccountResponse","data":{"type":"object","properties":{"accountID":{"type":"string","description":"it indicates unique cost account ID created by system","example":"absjf878"},"name":{"type":"string","description":"this indicates the name of cost account","example":"name"},"code":{"type":"string","description":"this indicates the code of cost account","example":"code"},"parent":{"type":"string","description":"this indicates cost account Id of parent account","example":""},"description":{"type":"string","description":"this indicates the description you want to provide for cost account","example":"description"},"status":{"type":"boolean","description":"It indicates if cost account is active or inactive"},"passwordEnabled":{"type":"boolean","description":"It indicates if password is enabled on cost account"},"passwordCode":{"type":"string","description":"It indicates password for the cost account","example":"test"},"billable":{"type":"boolean","description":"It indicates if cost account is billable"},"advanceOption":{"type":"object","description":"Additional configuration options for assigning the cost account to a specific  hierarchy level (Enterprise, Division, or Location). If no permission is provided, the cost account is assigned to the Enterprise level by default.","properties":{"permission":{"type":"object","description":"Defines the hierarchy level and corresponding entity values where this cost account will be available.","properties":{"permissionByEntity":{"type":"string","description":"Indicates the hierarchy level at which the cost account is assigned.\nSupported values:\n","enum":["D","L","E"]},"permissionByValue":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The list of identifiers corresponding to the selected hierarchy level."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Division IDs if permissionByEntity = D "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Location IDs if permissionByEntity = L "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enterprise ID f permissionByEntity = E"},"children":[]}]}]}],"items":{"type":"string"}}}}},"example":{"permission":{"permissionByEntity":"D","permissionByValue":["div_auto_sac11be"]}}}}}},"components/schemas/GetCostAccountsResponse":{"id":"components/schemas/GetCostAccountsResponse","kind":"json-schema","title":"GetCostAccountsResponse","data":{"type":"object","properties":{"data":{"type":"array","description":"it displays all the cost accounts","items":{"type":"object","properties":{"accountID":{"type":"string","description":"it indicates unique cost account ID created by system","example":"absh7830"},"name":{"type":"string","description":"this indicates the name of cost account","example":"name"},"code":{"type":"string","description":"this indicates the code of cost account","example":"code"},"parent":{"type":"string","description":"this indicates cost account Id of parent account","example":""},"description":{"type":"string","description":"this indicates the description you want to provide for cost account","example":"description"},"status":{"type":"boolean","description":"It indicates if cost account is active or inactive"},"passwordEnabled":{"type":"boolean","description":"It indicates if password is enabled on cost account"},"passwordCode":{"type":"string","description":"It indicates password for the cost account","example":"test"},"billable":{"type":"boolean","description":"It indicates if cost account is billable"},"advanceOption":{"type":"object","description":"Additional configuration options for assigning the cost account to a specific  hierarchy level (Enterprise, Division, or Location). If no permission is provided, the cost account is assigned to the Enterprise level by default.","properties":{"permission":{"type":"object","description":"Defines the hierarchy level and corresponding entity values where this cost account will be available.","properties":{"permissionByEntity":{"type":"string","description":"Indicates the hierarchy level at which the cost account is assigned.\nSupported values:\n","enum":["D","L","E"]},"permissionByValue":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The list of identifiers corresponding to the selected hierarchy level."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Division IDs if permissionByEntity = D "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Location IDs if permissionByEntity = L "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enterprise ID f permissionByEntity = E"},"children":[]}]}]}],"items":{"type":"string"}}}}},"example":{"permission":{"permissionByEntity":"D","permissionByValue":["div_auto_sac11be"]}}}}}}}}},"components/schemas/CostAccountResponse":{"id":"components/schemas/CostAccountResponse","kind":"json-schema","title":"CostAccountResponse","data":{"type":"object","properties":{"accountID":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique cost account id generated by system. When used in Shipment APIs, this field is referred to as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"costAccountId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}}},"components/schemas/UpdateCostAccount":{"id":"components/schemas/UpdateCostAccount","kind":"json-schema","title":"UpdateCostAccount","data":{"type":"object","properties":{"description":{"type":"string","description":"this indicates the description of cost account","example":"description"},"status":{"type":"boolean","description":"this indicates if cost account is active"},"passwordEnabled":{"type":"boolean","description":"this indicates if password is enabled"},"passwordCode":{"type":"string","description":"this defines password set for the cost account","example":"test"},"billable":{"type":"boolean","description":"this indicates if cost account is billable"},"advanceOption":{"type":"object","description":"Additional configuration options for assigning the cost account to a specific  hierarchy level (Enterprise, Division, or Location). If no permission is provided, the cost account is assigned to the Enterprise level by default.","properties":{"permission":{"type":"object","description":"Defines the hierarchy level and corresponding entity values where this cost account will be available.","properties":{"permissionByEntity":{"type":"string","description":"Indicates the hierarchy level at which the cost account is assigned.\nSupported values:\n","enum":["D","L","E"]},"permissionByValue":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The list of identifiers corresponding to the selected hierarchy level."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Division IDs if permissionByEntity = D "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Location IDs if permissionByEntity = L "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enterprise ID f permissionByEntity = E"},"children":[]}]}]}],"items":{"type":"string"}}}}},"example":{"permission":{"permissionByEntity":"D","permissionByValue":["div_auto_sac11be"]}}}}}},"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":"array","items":{"type":"object","properties":{"errorCode":{"type":"string","description":"Error code(s) that appear due to HTTP  400- Invalid or Bad Request, e.g. validation-error.","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":"name - value missing."},"additionalInfo":{"type":"string","description":"This is an additional information about the error. This error 'Invalid Request' might appear due to invalid dimension, weight, or serviceid, or if the information is missing."},"additionalParameters":{"type":"array","items":{"type":"string","description":"The field(s) that might be incorrect in the request."}}}}}},"components/schemas/NotFoundErrors":{"id":"components/schemas/NotFoundErrors","kind":"json-schema","title":"NotFoundErrors","data":{"type":"array","items":{"type":"object","properties":{"errorCode":{"type":"string","example":"not_found","description":"Error code(s) that appear due HTTP 404 Page or File not found."},"errorDescription":{"type":"string","example":"resource not found","description":"Document not found."},"additionalInfo":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional information about the error. This error 'Not Found' might appear due to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Cost Account Not Found"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}}}},"components/schemas/ImportCostAccountResponse":{"id":"components/schemas/ImportCostAccountResponse","kind":"json-schema","title":"ImportCostAccountResponse","data":{"type":"object","properties":{"jobID":{"type":"string","description":"This is the system generated Job Id.","example":"L86wbedwBon"},"url":{"type":"string","description":"This is url to which csv file would be uploaded for importing cost accounts","example":"https://225934331380-sp360-shared-services-iad-qa.s3.amazonaws.com/CostAccount/import/upload/sac9f07/L86wbedwBon/import-costaccount-5a907730-10a0-4e52-a193-d50a0c8a3d0c.csv?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIATJGV4JX2F6MDPCWY%2F20230819%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20230819T114328Z&X-Amz-Expires=3600&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEOz%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCXVzLWVhc3QtMSJHMEUCIQDIoH3r4%2FoDb99MmVOIxECmLjIGc9lFQ8mIgp75wpd0TgIgGqrcq2A%2FJJDVvv3lQlDZo9Eodt7Cg8%2B9MnN3zyzu2p"}}}},"components/schemas/ProcessImportCostAccountResponse":{"id":"components/schemas/ProcessImportCostAccountResponse","kind":"json-schema","title":"ProcessImportCostAccountResponse","data":{"type":"object","properties":{"jobID":{"type":"string","description":"It displays the jobID for which processing is requested","example":"L86wbedwBon"},"status":{"type":"string","description":"It displays Job Status of submission, on successful submission it would show as Submitted","example":"SUBMITTED"}}}},"components/schemas/ImportCostAccountStatusResponse":{"id":"components/schemas/ImportCostAccountStatusResponse","kind":"json-schema","title":"ImportCostAccountStatusResponse","data":{"type":"object","properties":{"status":{"type":"string","description":"It shows the status of the Job- Completed or Failed","example":"Completed"},"jobID":{"type":"string","description":"It shows the JobID of the import cost account","example":"L86wbedwBon"},"RecordCounts":{"type":"object","properties":{"total":{"type":"number","description":"this indicates the total number of records"},"success":{"type":"number","description":"this indicates the number of success records"},"failed":{"type":"number","description":"this indicates the number of failed records"}}},"errorFileURL":{"type":"object","description":"It would only be visible when status is Failed","properties":{"csv":{"type":"string","description":"It shows the csv url which contains information about failed records","example":"https://225934331380-sp360-shared-services-iad-qa.s3.amazonaws.com/CostAccount/import/error/sac9f07/L86wbedwBon/Error-import-costaccount-5a907730-10a0-4e52-a193-d50a0c8a3d0c.csv?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIATJGV4JX2K7OIRQGI%2F20230819%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20230819T115234Z&X-Amz-Expires=900&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEOz%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCXVzLWVhc3QtMSJHMEUCIEg6jXh8GVV82wgPUv9NINpspM42vrB2zVWsqr3%2BbmXlAiEAgBxvyeN7fJzMXF40NzFhzTnGur8mfcPkKpAO56kBIPAqxQUIpP%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FARACGgwyMjU5MzQzMz"}}}}}},"schema_248":{"kind":"json-schema","data":{"type":"string"},"id":"schema_248"}},"exampleStore":{},"securitySchemeStore":{"basicAuth":{"id":"basicAuth","type":"http","scheme":"basic"},"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/costaccount.json?download"},{"url":"/_bundle/openapi/costaccount.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Cost Account APIs","description":"These APIs provides Cost Account management operations like creating Cost account, modify, get and delete."}},"baseSlug":"/openapi/costaccount","routesMapping":{}}