{"items":[{"type":"link","label":"Collect (Finance & Billing)","link":"/apis/collect/collect-v1","routeSlug":"/apis/collect/collect-v1","content":{"contentType":"overview","meta":{"name":"Collect (Finance & Billing)"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"collect-v1.json","url":"/_bundle/apis/collect/collect-v1.json?download"},{"kind":"download","label":"collect-v1.yaml","url":"/_bundle/apis/collect/collect-v1.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":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Collect (Finance & Billing) (v1-2025-04-18)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"The Finance, or Collect, API provides all the accounts receivable capabilities in Rhythm. This includes all aspects of \nInvoices, Credits, Payments, Credit Memos, and Debit Memos. Additionally, this API manages Batches and Fiscal Periods \nand can be used to download batches for import into your accounting package.\n\nLike most of the other Rhythm apps, the Collect API includes endpoints for Query Definitions. These endpoints are commonly\nused to retrieve saved queries, which can then be executed using the Query endpoints of the System API."}],"sectionId":"/apis/collect/collect-v1"}],"sectionId":"/apis/collect/collect-v1"}]}]}},{"type":"group","label":"Accounting Projects","link":"/apis/collect/collect-v1/accounting-projects","routeSlug":"/apis/collect/collect-v1/accounting-projects","items":[{"label":"Gets all of the accounting projects in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/accounting-projects/listaccountingprojects","routeSlug":"/apis/collect/collect-v1/accounting-projects/listaccountingprojects","metadata":{"seo":{"title":"Gets all of the accounting projects in the system.","description":"This method will scan all accounting projects and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listAccountingProjects","name":"Gets all of the accounting projects in the system.","isWebhook":false,"pointer":"/paths/~1accountingProjects~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the accounting projects in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all accounting projects and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1accountingProjects~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1accountingProjects~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/accountingProjects/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/accountingProjects/{tenantId}","href":"accounting-projects/listaccountingprojects","openApiOperationId":"listAccountingProjects","summary":"Gets all of the accounting projects in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The accounting projectswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_410"}},"schemaId":"schema_410","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1accountingProjects~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_410","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_410"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/accounting-projects/listaccountingprojects"}],"panels":[]}]},"httpPath":"/accountingProjects/{tenantId}"},{"label":"Creates a new accounting project record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/accounting-projects/createaccountingproject","routeSlug":"/apis/collect/collect-v1/accounting-projects/createaccountingproject","metadata":{"seo":{"title":"Creates a new accounting project record that does not already exist.","description":"This method will auto-generate an ID and create a new accounting project. If an ID is specified for the accounting project, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createAccountingProject","name":"Creates a new accounting project record that does not already exist.","isWebhook":false,"pointer":"/paths/~1accountingProjects~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new accounting project record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new accounting project. If an ID is specified for the accounting project, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1accountingProjects~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AccountingProject"}},"schemaId":"components/schemas/AccountingProject","pointer":"/paths/~1accountingProjects~1{tenantId}/post/requestBody","description":"The accounting project that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/accountingProjects/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AccountingProject"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/accountingProjects/{tenantId}","href":"accounting-projects/createaccountingproject","openApiOperationId":"createAccountingProject","summary":"Creates a new accounting project record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/AccountingProject","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AccountingProject"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The accounting project was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountingProject"}},"schemaId":"components/schemas/AccountingProject","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The accounting project you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The accounting project could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add accounting project based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1accountingProjects~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AccountingProject","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountingProject"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/accounting-projects/createaccountingproject"}],"panels":[]}]},"httpPath":"/accountingProjects/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/accounting-projects/executebatchoperations","routeSlug":"/apis/collect/collect-v1/accounting-projects/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1accountingProjects~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1accountingProjects~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1accountingProjects~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/accountingProjects/{tenantId}/batch","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/accountingProjects/{tenantId}/batch","href":"accounting-projects/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The accounting project could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve accounting project based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1accountingProjects~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/accounting-projects/executebatchoperations"}],"panels":[]}]},"httpPath":"/accountingProjects/{tenantId}/batch"},{"label":"Returns a accounting project from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/accounting-projects/deleteaccountingproject","routeSlug":"/apis/collect/collect-v1/accounting-projects/deleteaccountingproject","metadata":{"seo":{"title":"Returns a accounting project from the system by its ID.","description":"This method will delete a accounting project with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteAccountingProject","name":"Returns a accounting project from the system by its ID.","isWebhook":false,"pointer":"/paths/~1accountingProjects~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a accounting project from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a accounting project with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the accounting project to delete.","required":true}],"pointer":"/paths/~1accountingProjects~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/accountingProjects/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/accountingProjects/{tenantId}/{id}","href":"accounting-projects/deleteaccountingproject","openApiOperationId":"deleteAccountingProject","summary":"Returns a accounting project from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The accounting project was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}},"schemaId":"schema_409","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The accounting project could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The accounting project could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to delete accounting project based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1accountingProjects~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_409","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/accounting-projects/deleteaccountingproject"}],"panels":[]}]},"httpPath":"/accountingProjects/{tenantId}/{id}"},{"label":"Returns a accounting project from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/accounting-projects/getaccountingproject","routeSlug":"/apis/collect/collect-v1/accounting-projects/getaccountingproject","metadata":{"seo":{"title":"Returns a accounting project from the system by its ID.","description":"This method will look up a accounting project by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAccountingProject","name":"Returns a accounting project from the system by its ID.","isWebhook":false,"pointer":"/paths/~1accountingProjects~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a accounting project from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a accounting project by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the accounting project to return.","required":true}],"pointer":"/paths/~1accountingProjects~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_409","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1accountingProjects~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/accountingProjects/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/accountingProjects/{tenantId}/{id}","href":"accounting-projects/getaccountingproject","openApiOperationId":"getAccountingProject","summary":"Returns a accounting project from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The accounting project was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountingProject"}},"schemaId":"components/schemas/AccountingProject","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The accounting project could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve accounting project based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1accountingProjects~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AccountingProject","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountingProject"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/accounting-projects/getaccountingproject"}],"panels":[]}]},"httpPath":"/accountingProjects/{tenantId}/{id}"},{"label":"Partially updates a accounting project with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/accounting-projects/patchaccountingproject","routeSlug":"/apis/collect/collect-v1/accounting-projects/patchaccountingproject","metadata":{"seo":{"title":"Partially updates a accounting project with the specified ID.","description":"This method will patch an existing accounting project with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchAccountingProject","name":"Partially updates a accounting project with the specified ID.","isWebhook":false,"pointer":"/paths/~1accountingProjects~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a accounting project with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing accounting project with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the accounting project to patch.","required":true}],"pointer":"/paths/~1accountingProjects~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"schemaId":"schema_412","pointer":"/paths/~1accountingProjects~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/accountingProjects/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_412"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/accountingProjects/{tenantId}/{id}","href":"accounting-projects/patchaccountingproject","openApiOperationId":"patchAccountingProject","summary":"Partially updates a accounting project with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"schema_412","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The accounting project was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountingProject"}},"schemaId":"components/schemas/AccountingProject","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The accounting project could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The accounting project could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve accounting project based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1accountingProjects~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AccountingProject","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountingProject"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/accounting-projects/patchaccountingproject"}],"panels":[]}]},"httpPath":"/accountingProjects/{tenantId}/{id}"},{"label":"Updates a accounting project with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/accounting-projects/updateaccountingproject","routeSlug":"/apis/collect/collect-v1/accounting-projects/updateaccountingproject","metadata":{"seo":{"title":"Updates a accounting project with the specified ID.","description":"This method will update an existing accounting project with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateAccountingProject","name":"Updates a accounting project with the specified ID.","isWebhook":false,"pointer":"/paths/~1accountingProjects~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a accounting project with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing accounting project with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the accounting project to update.","required":true}],"pointer":"/paths/~1accountingProjects~1{tenantId}~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/AccountingProject"}},"schemaId":"components/schemas/AccountingProject","pointer":"/paths/~1accountingProjects~1{tenantId}~1{id}/put/requestBody","description":"The updated accounting project that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/accountingProjects/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AccountingProject"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/accountingProjects/{tenantId}/{id}","href":"accounting-projects/updateaccountingproject","openApiOperationId":"updateAccountingProject","summary":"Updates a accounting project with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/AccountingProject","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AccountingProject"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The accounting project was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountingProject"}},"schemaId":"components/schemas/AccountingProject","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The accounting project supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The accounting project could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The accounting project could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve accounting project based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1accountingProjects~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AccountingProject","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AccountingProject"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/accounting-projects/updateaccountingproject"}],"panels":[]}]},"httpPath":"/accountingProjects/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Accounting Projects"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Accounting Projects","showPageActions":true},{"nodeType":"markdoc","content":"Accounting Projects"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/accountingProjects/{tenantId}","summary":"Gets all of the accounting projects in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/accounting-projects/listaccountingprojects","deprecated":false},{"title":"/accountingProjects/{tenantId}","summary":"Creates a new accounting project record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/accounting-projects/createaccountingproject","deprecated":false},{"title":"/accountingProjects/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/accounting-projects/executebatchoperations","deprecated":false},{"title":"/accountingProjects/{tenantId}/{id}","summary":"Returns a accounting project from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/accounting-projects/deleteaccountingproject","deprecated":false},{"title":"/accountingProjects/{tenantId}/{id}","summary":"Returns a accounting project from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/accounting-projects/getaccountingproject","deprecated":false},{"title":"/accountingProjects/{tenantId}/{id}","summary":"Partially updates a accounting project with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/accounting-projects/patchaccountingproject","deprecated":false},{"title":"/accountingProjects/{tenantId}/{id}","summary":"Updates a accounting project with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/accounting-projects/updateaccountingproject","deprecated":false}]}]}]}]}},{"type":"group","label":"Bank Accounts","link":"/apis/collect/collect-v1/bank-accounts","routeSlug":"/apis/collect/collect-v1/bank-accounts","items":[{"label":"Gets all of the bank accounts in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/bank-accounts/listbankaccounts","routeSlug":"/apis/collect/collect-v1/bank-accounts/listbankaccounts","metadata":{"seo":{"title":"Gets all of the bank accounts in the system.","description":"This method will scan all bank accounts and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listBankAccounts","name":"Gets all of the bank accounts in the system.","isWebhook":false,"pointer":"/paths/~1bankAccounts~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the bank accounts in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all bank accounts and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1bankAccounts~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1bankAccounts~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/bankAccounts/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/bankAccounts/{tenantId}","href":"bank-accounts/listbankaccounts","openApiOperationId":"listBankAccounts","summary":"Gets all of the bank accounts in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The bank accountswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_413"}},"schemaId":"schema_413","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1bankAccounts~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_413","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_413"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bank-accounts/listbankaccounts"}],"panels":[]}]},"httpPath":"/bankAccounts/{tenantId}"},{"label":"Creates a new bank account record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/bank-accounts/createbankaccount","routeSlug":"/apis/collect/collect-v1/bank-accounts/createbankaccount","metadata":{"seo":{"title":"Creates a new bank account record that does not already exist.","description":"This method will auto-generate an ID and create a new bank account. If an ID is specified for the bank account, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createBankAccount","name":"Creates a new bank account record that does not already exist.","isWebhook":false,"pointer":"/paths/~1bankAccounts~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new bank account record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new bank account. If an ID is specified for the bank account, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1bankAccounts~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BankAccount"}},"schemaId":"components/schemas/BankAccount","pointer":"/paths/~1bankAccounts~1{tenantId}/post/requestBody","description":"The bank account that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/bankAccounts/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BankAccount"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/bankAccounts/{tenantId}","href":"bank-accounts/createbankaccount","openApiOperationId":"createBankAccount","summary":"Creates a new bank account record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BankAccount","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BankAccount"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The bank account was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BankAccount"}},"schemaId":"components/schemas/BankAccount","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The bank account you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The bank account could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add bank account based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1bankAccounts~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BankAccount","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BankAccount"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bank-accounts/createbankaccount"}],"panels":[]}]},"httpPath":"/bankAccounts/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/bank-accounts/executebatchoperations","routeSlug":"/apis/collect/collect-v1/bank-accounts/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1bankAccounts~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1bankAccounts~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1bankAccounts~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/bankAccounts/{tenantId}/batch","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/bankAccounts/{tenantId}/batch","href":"bank-accounts/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The bank account could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve bank account based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1bankAccounts~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bank-accounts/executebatchoperations"}],"panels":[]}]},"httpPath":"/bankAccounts/{tenantId}/batch"},{"label":"Returns a bank account from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/bank-accounts/deletebankaccount","routeSlug":"/apis/collect/collect-v1/bank-accounts/deletebankaccount","metadata":{"seo":{"title":"Returns a bank account from the system by its ID.","description":"This method will delete a bank account with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteBankAccount","name":"Returns a bank account from the system by its ID.","isWebhook":false,"pointer":"/paths/~1bankAccounts~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a bank account from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a bank account with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the bank account to delete.","required":true}],"pointer":"/paths/~1bankAccounts~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/bankAccounts/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/bankAccounts/{tenantId}/{id}","href":"bank-accounts/deletebankaccount","openApiOperationId":"deleteBankAccount","summary":"Returns a bank account from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The bank account was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}},"schemaId":"schema_409","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The bank account could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The bank account could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to delete bank account based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1bankAccounts~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_409","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bank-accounts/deletebankaccount"}],"panels":[]}]},"httpPath":"/bankAccounts/{tenantId}/{id}"},{"label":"Returns a bank account from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/bank-accounts/getbankaccount","routeSlug":"/apis/collect/collect-v1/bank-accounts/getbankaccount","metadata":{"seo":{"title":"Returns a bank account from the system by its ID.","description":"This method will look up a bank account by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getBankAccount","name":"Returns a bank account from the system by its ID.","isWebhook":false,"pointer":"/paths/~1bankAccounts~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a bank account from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a bank account by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the bank account to return.","required":true}],"pointer":"/paths/~1bankAccounts~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_409","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1bankAccounts~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/bankAccounts/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/bankAccounts/{tenantId}/{id}","href":"bank-accounts/getbankaccount","openApiOperationId":"getBankAccount","summary":"Returns a bank account from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The bank account was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BankAccount"}},"schemaId":"components/schemas/BankAccount","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The bank account could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve bank account based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1bankAccounts~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BankAccount","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BankAccount"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bank-accounts/getbankaccount"}],"panels":[]}]},"httpPath":"/bankAccounts/{tenantId}/{id}"},{"label":"Partially updates a bank account with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/bank-accounts/patchbankaccount","routeSlug":"/apis/collect/collect-v1/bank-accounts/patchbankaccount","metadata":{"seo":{"title":"Partially updates a bank account with the specified ID.","description":"This method will patch an existing bank account with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchBankAccount","name":"Partially updates a bank account with the specified ID.","isWebhook":false,"pointer":"/paths/~1bankAccounts~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a bank account with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing bank account with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the bank account to patch.","required":true}],"pointer":"/paths/~1bankAccounts~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"schemaId":"schema_412","pointer":"/paths/~1bankAccounts~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/bankAccounts/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_412"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/bankAccounts/{tenantId}/{id}","href":"bank-accounts/patchbankaccount","openApiOperationId":"patchBankAccount","summary":"Partially updates a bank account with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"schema_412","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The bank account was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BankAccount"}},"schemaId":"components/schemas/BankAccount","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The bank account could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The bank account could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve bank account based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1bankAccounts~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BankAccount","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BankAccount"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bank-accounts/patchbankaccount"}],"panels":[]}]},"httpPath":"/bankAccounts/{tenantId}/{id}"},{"label":"Updates a bank account with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/bank-accounts/updatebankaccount","routeSlug":"/apis/collect/collect-v1/bank-accounts/updatebankaccount","metadata":{"seo":{"title":"Updates a bank account with the specified ID.","description":"This method will update an existing bank account with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateBankAccount","name":"Updates a bank account with the specified ID.","isWebhook":false,"pointer":"/paths/~1bankAccounts~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a bank account with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing bank account with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the bank account to update.","required":true}],"pointer":"/paths/~1bankAccounts~1{tenantId}~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/BankAccount"}},"schemaId":"components/schemas/BankAccount","pointer":"/paths/~1bankAccounts~1{tenantId}~1{id}/put/requestBody","description":"The updated bank account that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/bankAccounts/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BankAccount"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/bankAccounts/{tenantId}/{id}","href":"bank-accounts/updatebankaccount","openApiOperationId":"updateBankAccount","summary":"Updates a bank account with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BankAccount","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BankAccount"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The bank account was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BankAccount"}},"schemaId":"components/schemas/BankAccount","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The bank account supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The bank account could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The bank account could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve bank account based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1bankAccounts~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BankAccount","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BankAccount"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/bank-accounts/updatebankaccount"}],"panels":[]}]},"httpPath":"/bankAccounts/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Bank Accounts"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Bank Accounts","showPageActions":true},{"nodeType":"markdoc","content":"Bank Accounts"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/bankAccounts/{tenantId}","summary":"Gets all of the bank accounts in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/bank-accounts/listbankaccounts","deprecated":false},{"title":"/bankAccounts/{tenantId}","summary":"Creates a new bank account record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/bank-accounts/createbankaccount","deprecated":false},{"title":"/bankAccounts/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/bank-accounts/executebatchoperations","deprecated":false},{"title":"/bankAccounts/{tenantId}/{id}","summary":"Returns a bank account from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/bank-accounts/deletebankaccount","deprecated":false},{"title":"/bankAccounts/{tenantId}/{id}","summary":"Returns a bank account from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/bank-accounts/getbankaccount","deprecated":false},{"title":"/bankAccounts/{tenantId}/{id}","summary":"Partially updates a bank account with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/bank-accounts/patchbankaccount","deprecated":false},{"title":"/bankAccounts/{tenantId}/{id}","summary":"Updates a bank account with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/bank-accounts/updatebankaccount","deprecated":false}]}]}]}]}},{"type":"group","label":"Batch Assignment Settings","link":"/apis/collect/collect-v1/batch-assignment-settings","routeSlug":"/apis/collect/collect-v1/batch-assignment-settings","items":[{"label":"Gets all of the batch assignment settings in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/batch-assignment-settings/listbatchassignmentsettings","routeSlug":"/apis/collect/collect-v1/batch-assignment-settings/listbatchassignmentsettings","metadata":{"seo":{"title":"Gets all of the batch assignment settings in the system.","description":"This method will scan all batch assignment settings and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listBatchAssignmentSettings","name":"Gets all of the batch assignment settings in the system.","isWebhook":false,"pointer":"/paths/~1batchAssignmentSettings~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the batch assignment settings in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all batch assignment settings and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1batchAssignmentSettings~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1batchAssignmentSettings~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/batchAssignmentSettings/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/batchAssignmentSettings/{tenantId}","href":"batch-assignment-settings/listbatchassignmentsettings","openApiOperationId":"listBatchAssignmentSettings","summary":"Gets all of the batch assignment settings in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The batch assignment settingswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_414"}},"schemaId":"schema_414","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1batchAssignmentSettings~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_414","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_414"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/batch-assignment-settings/listbatchassignmentsettings"}],"panels":[]}]},"httpPath":"/batchAssignmentSettings/{tenantId}"},{"label":"Creates a new batch assignment setting record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/batch-assignment-settings/createbatchassignmentsetting","routeSlug":"/apis/collect/collect-v1/batch-assignment-settings/createbatchassignmentsetting","metadata":{"seo":{"title":"Creates a new batch assignment setting record that does not already exist.","description":"This method will auto-generate an ID and create a new batch assignment setting. If an ID is specified for the batch assignment setting, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createBatchAssignmentSetting","name":"Creates a new batch assignment setting record that does not already exist.","isWebhook":false,"pointer":"/paths/~1batchAssignmentSettings~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new batch assignment setting record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new batch assignment setting. If an ID is specified for the batch assignment setting, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1batchAssignmentSettings~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchAssignmentSetting"}},"schemaId":"components/schemas/BatchAssignmentSetting","pointer":"/paths/~1batchAssignmentSettings~1{tenantId}/post/requestBody","description":"The batch assignment setting that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/batchAssignmentSettings/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchAssignmentSetting"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/batchAssignmentSettings/{tenantId}","href":"batch-assignment-settings/createbatchassignmentsetting","openApiOperationId":"createBatchAssignmentSetting","summary":"Creates a new batch assignment setting record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchAssignmentSetting","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchAssignmentSetting"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The batch assignment setting was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchAssignmentSetting"}},"schemaId":"components/schemas/BatchAssignmentSetting","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The batch assignment setting you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The batch assignment setting could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add batch assignment setting based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1batchAssignmentSettings~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchAssignmentSetting","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchAssignmentSetting"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/batch-assignment-settings/createbatchassignmentsetting"}],"panels":[]}]},"httpPath":"/batchAssignmentSettings/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/batch-assignment-settings/executebatchoperations","routeSlug":"/apis/collect/collect-v1/batch-assignment-settings/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1batchAssignmentSettings~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1batchAssignmentSettings~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1batchAssignmentSettings~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/batchAssignmentSettings/{tenantId}/batch","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/batchAssignmentSettings/{tenantId}/batch","href":"batch-assignment-settings/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The batch assignment setting could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve batch assignment setting based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1batchAssignmentSettings~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/batch-assignment-settings/executebatchoperations"}],"panels":[]}]},"httpPath":"/batchAssignmentSettings/{tenantId}/batch"},{"label":"For a given transaction, determines the default batch","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/batch-assignment-settings/calculatedefaultbatchfortransaction","routeSlug":"/apis/collect/collect-v1/batch-assignment-settings/calculatedefaultbatchfortransaction","metadata":{"seo":{"title":"For a given transaction, determines the default batch","description":"For a given transaction, determines the default batch"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"calculateDefaultBatchForTransaction","name":"For a given transaction, determines the default batch","isWebhook":false,"pointer":"/paths/~1batchAssignmentSettings~1{tenantId}~1defaultBatch~1{transactionType}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"For a given transaction, determines the default batch","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"For a given transaction, determines the default batch"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed","required":true},{"name":"transactionType","in":"path","schemaId":"schema_409","description":"The type of transaction","required":true}],"pointer":"/paths/~1batchAssignmentSettings~1{tenantId}~1defaultBatch~1{transactionType}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_415"}},"schemaId":"schema_415","pointer":"/paths/~1batchAssignmentSettings~1{tenantId}~1defaultBatch~1{transactionType}/post/requestBody","description":"The transaction"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/batchAssignmentSettings/{tenantId}/defaultBatch/{transactionType}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"transactionType","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_415"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/batchAssignmentSettings/{tenantId}/defaultBatch/{transactionType}","href":"batch-assignment-settings/calculatedefaultbatchfortransaction","openApiOperationId":"calculateDefaultBatchForTransaction","summary":"For a given transaction, determines the default batch"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"schema_415","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_415"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The batch assignment setting was retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}},"schemaId":"schema_409","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The batch assignment setting could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve batch assignment setting based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1batchAssignmentSettings~1{tenantId}~1defaultBatch~1{transactionType}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_409","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/batch-assignment-settings/calculatedefaultbatchfortransaction"}],"panels":[]}]},"httpPath":"/batchAssignmentSettings/{tenantId}/defaultBatch/{transactionType}"},{"label":"Returns a batch assignment setting from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/batch-assignment-settings/deletebatchassignmentsetting","routeSlug":"/apis/collect/collect-v1/batch-assignment-settings/deletebatchassignmentsetting","metadata":{"seo":{"title":"Returns a batch assignment setting from the system by its ID.","description":"This method will delete a batch assignment setting with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteBatchAssignmentSetting","name":"Returns a batch assignment setting from the system by its ID.","isWebhook":false,"pointer":"/paths/~1batchAssignmentSettings~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a batch assignment setting from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a batch assignment setting with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the batch assignment setting to delete.","required":true}],"pointer":"/paths/~1batchAssignmentSettings~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/batchAssignmentSettings/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/batchAssignmentSettings/{tenantId}/{id}","href":"batch-assignment-settings/deletebatchassignmentsetting","openApiOperationId":"deleteBatchAssignmentSetting","summary":"Returns a batch assignment setting from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The batch assignment setting was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}},"schemaId":"schema_409","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The batch assignment setting could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The batch assignment setting could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to delete batch assignment setting based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1batchAssignmentSettings~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_409","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/batch-assignment-settings/deletebatchassignmentsetting"}],"panels":[]}]},"httpPath":"/batchAssignmentSettings/{tenantId}/{id}"},{"label":"Returns a batch assignment setting from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/batch-assignment-settings/getbatchassignmentsetting","routeSlug":"/apis/collect/collect-v1/batch-assignment-settings/getbatchassignmentsetting","metadata":{"seo":{"title":"Returns a batch assignment setting from the system by its ID.","description":"This method will look up a batch assignment setting by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getBatchAssignmentSetting","name":"Returns a batch assignment setting from the system by its ID.","isWebhook":false,"pointer":"/paths/~1batchAssignmentSettings~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a batch assignment setting from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a batch assignment setting by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the batch assignment setting to return.","required":true}],"pointer":"/paths/~1batchAssignmentSettings~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_409","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1batchAssignmentSettings~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/batchAssignmentSettings/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/batchAssignmentSettings/{tenantId}/{id}","href":"batch-assignment-settings/getbatchassignmentsetting","openApiOperationId":"getBatchAssignmentSetting","summary":"Returns a batch assignment setting from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The batch assignment setting was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchAssignmentSetting"}},"schemaId":"components/schemas/BatchAssignmentSetting","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The batch assignment setting could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve batch assignment setting based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1batchAssignmentSettings~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchAssignmentSetting","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchAssignmentSetting"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/batch-assignment-settings/getbatchassignmentsetting"}],"panels":[]}]},"httpPath":"/batchAssignmentSettings/{tenantId}/{id}"},{"label":"Partially updates a batch assignment setting with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/batch-assignment-settings/patchbatchassignmentsetting","routeSlug":"/apis/collect/collect-v1/batch-assignment-settings/patchbatchassignmentsetting","metadata":{"seo":{"title":"Partially updates a batch assignment setting with the specified ID.","description":"This method will patch an existing batch assignment setting with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchBatchAssignmentSetting","name":"Partially updates a batch assignment setting with the specified ID.","isWebhook":false,"pointer":"/paths/~1batchAssignmentSettings~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a batch assignment setting with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing batch assignment setting with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the batch assignment setting to patch.","required":true}],"pointer":"/paths/~1batchAssignmentSettings~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"schemaId":"schema_412","pointer":"/paths/~1batchAssignmentSettings~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/batchAssignmentSettings/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_412"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/batchAssignmentSettings/{tenantId}/{id}","href":"batch-assignment-settings/patchbatchassignmentsetting","openApiOperationId":"patchBatchAssignmentSetting","summary":"Partially updates a batch assignment setting with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"schema_412","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The batch assignment setting was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchAssignmentSetting"}},"schemaId":"components/schemas/BatchAssignmentSetting","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The batch assignment setting could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The batch assignment setting could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve batch assignment setting based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1batchAssignmentSettings~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchAssignmentSetting","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchAssignmentSetting"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/batch-assignment-settings/patchbatchassignmentsetting"}],"panels":[]}]},"httpPath":"/batchAssignmentSettings/{tenantId}/{id}"},{"label":"Updates a batch assignment setting with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/batch-assignment-settings/updatebatchassignmentsetting","routeSlug":"/apis/collect/collect-v1/batch-assignment-settings/updatebatchassignmentsetting","metadata":{"seo":{"title":"Updates a batch assignment setting with the specified ID.","description":"This method will update an existing batch assignment setting with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateBatchAssignmentSetting","name":"Updates a batch assignment setting with the specified ID.","isWebhook":false,"pointer":"/paths/~1batchAssignmentSettings~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a batch assignment setting with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing batch assignment setting with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the batch assignment setting to update.","required":true}],"pointer":"/paths/~1batchAssignmentSettings~1{tenantId}~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/BatchAssignmentSetting"}},"schemaId":"components/schemas/BatchAssignmentSetting","pointer":"/paths/~1batchAssignmentSettings~1{tenantId}~1{id}/put/requestBody","description":"The updated batch assignment setting that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/batchAssignmentSettings/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchAssignmentSetting"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/batchAssignmentSettings/{tenantId}/{id}","href":"batch-assignment-settings/updatebatchassignmentsetting","openApiOperationId":"updateBatchAssignmentSetting","summary":"Updates a batch assignment setting with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchAssignmentSetting","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchAssignmentSetting"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The batch assignment setting was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchAssignmentSetting"}},"schemaId":"components/schemas/BatchAssignmentSetting","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The batch assignment setting supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The batch assignment setting could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The batch assignment setting could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve batch assignment setting based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1batchAssignmentSettings~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchAssignmentSetting","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchAssignmentSetting"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/batch-assignment-settings/updatebatchassignmentsetting"}],"panels":[]}]},"httpPath":"/batchAssignmentSettings/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Batch Assignment Settings"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Batch Assignment Settings","showPageActions":true},{"nodeType":"markdoc","content":"Batch Assignment Settings"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/batchAssignmentSettings/{tenantId}","summary":"Gets all of the batch assignment settings in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/batch-assignment-settings/listbatchassignmentsettings","deprecated":false},{"title":"/batchAssignmentSettings/{tenantId}","summary":"Creates a new batch assignment setting record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/batch-assignment-settings/createbatchassignmentsetting","deprecated":false},{"title":"/batchAssignmentSettings/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/batch-assignment-settings/executebatchoperations","deprecated":false},{"title":"/batchAssignmentSettings/{tenantId}/defaultBatch/{transactionType}","summary":"For a given transaction, determines the default batch","prefix":{"name":"post","color":"post"},"badges":[],"link":"/batch-assignment-settings/calculatedefaultbatchfortransaction","deprecated":false},{"title":"/batchAssignmentSettings/{tenantId}/{id}","summary":"Returns a batch assignment setting from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/batch-assignment-settings/deletebatchassignmentsetting","deprecated":false},{"title":"/batchAssignmentSettings/{tenantId}/{id}","summary":"Returns a batch assignment setting from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/batch-assignment-settings/getbatchassignmentsetting","deprecated":false},{"title":"/batchAssignmentSettings/{tenantId}/{id}","summary":"Partially updates a batch assignment setting with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/batch-assignment-settings/patchbatchassignmentsetting","deprecated":false},{"title":"/batchAssignmentSettings/{tenantId}/{id}","summary":"Updates a batch assignment setting with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/batch-assignment-settings/updatebatchassignmentsetting","deprecated":false}]}]}]}]}},{"type":"group","label":"Batch Downloading","link":"/apis/collect/collect-v1/batch-downloading","routeSlug":"/apis/collect/collect-v1/batch-downloading","items":[{"label":"Initiates workflow to warm up inventory transactions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/batch-downloading/warmupstepfunctions","routeSlug":"/apis/collect/collect-v1/batch-downloading/warmupstepfunctions","metadata":{"seo":{"title":"Initiates workflow to warm up inventory transactions","description":"Initiates workflow to warm up inventory transactions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"warmUpStepFunctions","name":"Initiates workflow to warm up inventory transactions","isWebhook":false,"pointer":"/paths/~1batchDownloading~1warmUpStepFunctions/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Initiates workflow to warm up inventory transactions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/batchDownloading/warmUpStepFunctions","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/batchDownloading/warmUpStepFunctions","href":"batch-downloading/warmupstepfunctions","openApiOperationId":"warmUpStepFunctions","summary":"Initiates workflow to warm up inventory transactions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Request limit exceeded... please try your request again in a few seconds","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"An internal server error occured.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1batchDownloading~1warmUpStepFunctions/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/batch-downloading/warmupstepfunctions"}],"panels":[]}]},"httpPath":"/batchDownloading/warmUpStepFunctions"},{"label":"Starts the process of downloading batches","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/batch-downloading/initiatebatchdownload","routeSlug":"/apis/collect/collect-v1/batch-downloading/initiatebatchdownload","metadata":{"seo":{"title":"Starts the process of downloading batches","description":"Starts the process of downloading batches"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"initiateBatchDownload","name":"Starts the process of downloading batches","isWebhook":false,"pointer":"/paths/~1batchDownloading~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Starts the process of downloading batches","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Starts the process of downloading batches"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed","required":true}],"pointer":"/paths/~1batchDownloading~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchDownloadingPayload"}},"schemaId":"components/schemas/BatchDownloadingPayload","pointer":"/paths/~1batchDownloading~1{tenantId}/post/requestBody","description":"The batch downloading that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/batchDownloading/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchDownloadingPayload"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/batchDownloading/{tenantId}","href":"batch-downloading/initiatebatchdownload","openApiOperationId":"initiateBatchDownload","summary":"Starts the process of downloading batches"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchDownloadingPayload","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchDownloadingPayload"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The batch downloading was initiated successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StepFunctionExecutionToken"}},"schemaId":"components/schemas/StepFunctionExecutionToken","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The batch downloading record you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The batch downloading could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add batch downloading based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1batchDownloading~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/StepFunctionExecutionToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StepFunctionExecutionToken"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/batch-downloading/initiatebatchdownload"}],"panels":[]}]},"httpPath":"/batchDownloading/{tenantId}"},{"label":"Allows for previewing batch template","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/batch-downloading/previewbatchtemplate","routeSlug":"/apis/collect/collect-v1/batch-downloading/previewbatchtemplate","metadata":{"seo":{"title":"Allows for previewing batch template","description":"Starts the process of downloading batches"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"previewBatchTemplate","name":"Allows for previewing batch template","isWebhook":false,"pointer":"/paths/~1batchDownloading~1{tenantId}~1preview/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Allows for previewing batch template","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Starts the process of downloading batches"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed","required":true}],"pointer":"/paths/~1batchDownloading~1{tenantId}~1preview/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PreviewBatchTemplateRequest"}},"schemaId":"components/schemas/PreviewBatchTemplateRequest","pointer":"/paths/~1batchDownloading~1{tenantId}~1preview/post/requestBody","description":"The batch template"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/batchDownloading/{tenantId}/preview","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PreviewBatchTemplateRequest"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/batchDownloading/{tenantId}/preview","href":"batch-downloading/previewbatchtemplate","openApiOperationId":"previewBatchTemplate","summary":"Allows for previewing batch template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/PreviewBatchTemplateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PreviewBatchTemplateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The batch downloading was initiated successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}},"schemaId":"schema_409","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The batch downloading record you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The batch downloading could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add batch downloading based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1batchDownloading~1{tenantId}~1preview/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_409","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/batch-downloading/previewbatchtemplate"}],"panels":[]}]},"httpPath":"/batchDownloading/{tenantId}/preview"}],"content":{"contentType":"group","meta":{"name":"Batch Downloading"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Batch Downloading","showPageActions":true},{"nodeType":"markdoc","content":"Batch Downloading"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/batchDownloading/warmUpStepFunctions","summary":"Initiates workflow to warm up inventory transactions","prefix":{"name":"post","color":"post"},"badges":[],"link":"/batch-downloading/warmupstepfunctions","deprecated":false},{"title":"/batchDownloading/{tenantId}","summary":"Starts the process of downloading batches","prefix":{"name":"post","color":"post"},"badges":[],"link":"/batch-downloading/initiatebatchdownload","deprecated":false},{"title":"/batchDownloading/{tenantId}/preview","summary":"Allows for previewing batch template","prefix":{"name":"post","color":"post"},"badges":[],"link":"/batch-downloading/previewbatchtemplate","deprecated":false}]}]}]}]}},{"type":"group","label":"Batch Posting","link":"/apis/collect/collect-v1/batch-posting","routeSlug":"/apis/collect/collect-v1/batch-posting","items":[{"label":"Initiates workflow to warm up inventory transactions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/batch-posting/warmupstepfunctions","routeSlug":"/apis/collect/collect-v1/batch-posting/warmupstepfunctions","metadata":{"seo":{"title":"Initiates workflow to warm up inventory transactions","description":"Initiates workflow to warm up inventory transactions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"warmUpStepFunctions","name":"Initiates workflow to warm up inventory transactions","isWebhook":false,"pointer":"/paths/~1batchPosting~1warmUpStepFunctions/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Initiates workflow to warm up inventory transactions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/batchPosting/warmUpStepFunctions","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/batchPosting/warmUpStepFunctions","href":"batch-posting/warmupstepfunctions","openApiOperationId":"warmUpStepFunctions","summary":"Initiates workflow to warm up inventory transactions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Request limit exceeded... please try your request again in a few seconds","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"An internal server error occured.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1batchPosting~1warmUpStepFunctions/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/batch-posting/warmupstepfunctions"}],"panels":[]}]},"httpPath":"/batchPosting/warmUpStepFunctions"},{"label":"Previews the batch to ensure it can be posted, and reports any errors","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/batch-posting/previewbatchposting","routeSlug":"/apis/collect/collect-v1/batch-posting/previewbatchposting","metadata":{"seo":{"title":"Previews the batch to ensure it can be posted, and reports any errors","description":"Previews the batch to ensure it can be posted, and reports any errors"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"previewBatchPosting","name":"Previews the batch to ensure it can be posted, and reports any errors","isWebhook":false,"pointer":"/paths/~1batchPosting~1{tenantId}~1batchPostingPreviewRequest/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Previews the batch to ensure it can be posted, and reports any errors","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Previews the batch to ensure it can be posted, and reports any errors"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed","required":true}],"pointer":"/paths/~1batchPosting~1{tenantId}~1batchPostingPreviewRequest/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PostBatches"}},"schemaId":"components/schemas/PostBatches","pointer":"/paths/~1batchPosting~1{tenantId}~1batchPostingPreviewRequest/post/requestBody","description":"Paylaod containing the batches to unpost and other options"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/batchPosting/{tenantId}/batchPostingPreviewRequest","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PostBatches"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/batchPosting/{tenantId}/batchPostingPreviewRequest","href":"batch-posting/previewbatchposting","openApiOperationId":"previewBatchPosting","summary":"Previews the batch to ensure it can be posted, and reports any errors"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/PostBatches","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PostBatches"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"An execution ARN to be used to monitor the batch unposting process.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchPreviewResult"}},"schemaId":"components/schemas/BatchPreviewResult","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The batch record you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The batch could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add batch based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1batchPosting~1{tenantId}~1batchPostingPreviewRequest/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchPreviewResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchPreviewResult"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/batch-posting/previewbatchposting"}],"panels":[]}]},"httpPath":"/batchPosting/{tenantId}/batchPostingPreviewRequest"},{"label":"Initiates workflow to post multiple batches","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/batch-posting/postbatches","routeSlug":"/apis/collect/collect-v1/batch-posting/postbatches","metadata":{"seo":{"title":"Initiates workflow to post multiple batches","description":"This method will initiate the batch posting process for one or more supplied batches"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"postBatches","name":"Initiates workflow to post multiple batches","isWebhook":false,"pointer":"/paths/~1batchPosting~1{tenantId}~1batchPostingRequest/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Initiates workflow to post multiple batches","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will initiate the batch posting process for one or more supplied batches"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed","required":true}],"pointer":"/paths/~1batchPosting~1{tenantId}~1batchPostingRequest/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PostBatches"}},"schemaId":"components/schemas/PostBatches","pointer":"/paths/~1batchPosting~1{tenantId}~1batchPostingRequest/post/requestBody","description":"Paylaod containing the batches to post and other options"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/batchPosting/{tenantId}/batchPostingRequest","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PostBatches"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/batchPosting/{tenantId}/batchPostingRequest","href":"batch-posting/postbatches","openApiOperationId":"postBatches","summary":"Initiates workflow to post multiple batches"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/PostBatches","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PostBatches"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"An execution ARN to be used to monitor the batch posting process.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StepFunctionExecutionToken"}},"schemaId":"components/schemas/StepFunctionExecutionToken","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The batch record you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The batch could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add batch based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1batchPosting~1{tenantId}~1batchPostingRequest/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/StepFunctionExecutionToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StepFunctionExecutionToken"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/batch-posting/postbatches"}],"panels":[]}]},"httpPath":"/batchPosting/{tenantId}/batchPostingRequest"},{"label":"Initiates workflow to unpost multiple batches","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/batch-posting/unpostbatches","routeSlug":"/apis/collect/collect-v1/batch-posting/unpostbatches","metadata":{"seo":{"title":"Initiates workflow to unpost multiple batches","description":"This method will initiate the batch unposting process for one or more supplied batches"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"unpostBatches","name":"Initiates workflow to unpost multiple batches","isWebhook":false,"pointer":"/paths/~1batchPosting~1{tenantId}~1batchUnpostingRequest/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Initiates workflow to unpost multiple batches","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will initiate the batch unposting process for one or more supplied batches"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed","required":true}],"pointer":"/paths/~1batchPosting~1{tenantId}~1batchUnpostingRequest/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PostBatches"}},"schemaId":"components/schemas/PostBatches","pointer":"/paths/~1batchPosting~1{tenantId}~1batchUnpostingRequest/post/requestBody","description":"Paylaod containing the batches to unpost and other options"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/batchPosting/{tenantId}/batchUnpostingRequest","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PostBatches"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/batchPosting/{tenantId}/batchUnpostingRequest","href":"batch-posting/unpostbatches","openApiOperationId":"unpostBatches","summary":"Initiates workflow to unpost multiple batches"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/PostBatches","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PostBatches"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"An execution ARN to be used to monitor the batch unposting process.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StepFunctionExecutionToken"}},"schemaId":"components/schemas/StepFunctionExecutionToken","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The batch record you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The batch could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add batch based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1batchPosting~1{tenantId}~1batchUnpostingRequest/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/StepFunctionExecutionToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StepFunctionExecutionToken"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/batch-posting/unpostbatches"}],"panels":[]}]},"httpPath":"/batchPosting/{tenantId}/batchUnpostingRequest"},{"label":"Retrieves a subledger entry for a transaction","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/batch-posting/getsubledgerentryfortransaction","routeSlug":"/apis/collect/collect-v1/batch-posting/getsubledgerentryfortransaction","metadata":{"seo":{"title":"Retrieves a subledger entry for a transaction","description":"Retrieves a subledger entry for a transaction"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSubledgerEntryForTransaction","name":"Retrieves a subledger entry for a transaction","isWebhook":false,"pointer":"/paths/~1batchPosting~1{tenantId}~1subledgerEntry~1{batchId}~1{transactionId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieves a subledger entry for a transaction","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a subledger entry for a transaction"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed","required":true},{"name":"batchId","in":"path","schemaId":"schema_409","description":"The id of the batch","required":true},{"name":"transactionId","in":"path","schemaId":"schema_409","description":"The id of the transaction","required":true}],"pointer":"/paths/~1batchPosting~1{tenantId}~1subledgerEntry~1{batchId}~1{transactionId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/batchPosting/{tenantId}/subledgerEntry/{batchId}/{transactionId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"batchId","in":"path","required":true,"schemaId":"schema_409"},{"name":"transactionId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/batchPosting/{tenantId}/subledgerEntry/{batchId}/{transactionId}","href":"batch-posting/getsubledgerentryfortransaction","openApiOperationId":"getSubledgerEntryForTransaction","summary":"Retrieves a subledger entry for a transaction"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The transaction","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubledgerEntry"}},"schemaId":"components/schemas/SubledgerEntry","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The record you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The subledger entry could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add batch based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1batchPosting~1{tenantId}~1subledgerEntry~1{batchId}~1{transactionId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SubledgerEntry","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubledgerEntry"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/batch-posting/getsubledgerentryfortransaction"}],"panels":[]}]},"httpPath":"/batchPosting/{tenantId}/subledgerEntry/{batchId}/{transactionId}"}],"content":{"contentType":"group","meta":{"name":"Batch Posting"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Batch Posting","showPageActions":true},{"nodeType":"markdoc","content":"Batch Posting"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/batchPosting/warmUpStepFunctions","summary":"Initiates workflow to warm up inventory transactions","prefix":{"name":"post","color":"post"},"badges":[],"link":"/batch-posting/warmupstepfunctions","deprecated":false},{"title":"/batchPosting/{tenantId}/batchPostingPreviewRequest","summary":"Previews the batch to ensure it can be posted, and reports any errors","prefix":{"name":"post","color":"post"},"badges":[],"link":"/batch-posting/previewbatchposting","deprecated":false},{"title":"/batchPosting/{tenantId}/batchPostingRequest","summary":"Initiates workflow to post multiple batches","prefix":{"name":"post","color":"post"},"badges":[],"link":"/batch-posting/postbatches","deprecated":false},{"title":"/batchPosting/{tenantId}/batchUnpostingRequest","summary":"Initiates workflow to unpost multiple batches","prefix":{"name":"post","color":"post"},"badges":[],"link":"/batch-posting/unpostbatches","deprecated":false},{"title":"/batchPosting/{tenantId}/subledgerEntry/{batchId}/{transactionId}","summary":"Retrieves a subledger entry for a transaction","prefix":{"name":"get","color":"get"},"badges":[],"link":"/batch-posting/getsubledgerentryfortransaction","deprecated":false}]}]}]}]}},{"type":"group","label":"Batch Templates","link":"/apis/collect/collect-v1/batch-templates","routeSlug":"/apis/collect/collect-v1/batch-templates","items":[{"label":"Gets all of the batch templates in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/batch-templates/listbatchtemplates","routeSlug":"/apis/collect/collect-v1/batch-templates/listbatchtemplates","metadata":{"seo":{"title":"Gets all of the batch templates in the system.","description":"This method will scan all batch templates and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listBatchTemplates","name":"Gets all of the batch templates in the system.","isWebhook":false,"pointer":"/paths/~1batchTemplates~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the batch templates in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all batch templates and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1batchTemplates~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1batchTemplates~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/batchTemplates/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/batchTemplates/{tenantId}","href":"batch-templates/listbatchtemplates","openApiOperationId":"listBatchTemplates","summary":"Gets all of the batch templates in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The batch templateswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_416"}},"schemaId":"schema_416","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1batchTemplates~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_416","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_416"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/batch-templates/listbatchtemplates"}],"panels":[]}]},"httpPath":"/batchTemplates/{tenantId}"},{"label":"Creates a new batch template record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/batch-templates/createbatchtemplate","routeSlug":"/apis/collect/collect-v1/batch-templates/createbatchtemplate","metadata":{"seo":{"title":"Creates a new batch template record that does not already exist.","description":"This method will auto-generate an ID and create a new batch template. If an ID is specified for the batch template, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createBatchTemplate","name":"Creates a new batch template record that does not already exist.","isWebhook":false,"pointer":"/paths/~1batchTemplates~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new batch template record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new batch template. If an ID is specified for the batch template, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1batchTemplates~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchTemplate"}},"schemaId":"components/schemas/BatchTemplate","pointer":"/paths/~1batchTemplates~1{tenantId}/post/requestBody","description":"The batch template that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/batchTemplates/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchTemplate"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/batchTemplates/{tenantId}","href":"batch-templates/createbatchtemplate","openApiOperationId":"createBatchTemplate","summary":"Creates a new batch template record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchTemplate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchTemplate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The batch template was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchTemplate"}},"schemaId":"components/schemas/BatchTemplate","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The batch template you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The batch template could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add batch template based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1batchTemplates~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchTemplate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchTemplate"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/batch-templates/createbatchtemplate"}],"panels":[]}]},"httpPath":"/batchTemplates/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/batch-templates/executebatchoperations","routeSlug":"/apis/collect/collect-v1/batch-templates/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1batchTemplates~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1batchTemplates~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1batchTemplates~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/batchTemplates/{tenantId}/batch","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/batchTemplates/{tenantId}/batch","href":"batch-templates/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The batch template could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve batch template based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1batchTemplates~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/batch-templates/executebatchoperations"}],"panels":[]}]},"httpPath":"/batchTemplates/{tenantId}/batch"},{"label":"Returns a batch template from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/batch-templates/deletebatchtemplate","routeSlug":"/apis/collect/collect-v1/batch-templates/deletebatchtemplate","metadata":{"seo":{"title":"Returns a batch template from the system by its ID.","description":"This method will delete a batch template with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteBatchTemplate","name":"Returns a batch template from the system by its ID.","isWebhook":false,"pointer":"/paths/~1batchTemplates~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a batch template from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a batch template with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the batch template to delete.","required":true}],"pointer":"/paths/~1batchTemplates~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/batchTemplates/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/batchTemplates/{tenantId}/{id}","href":"batch-templates/deletebatchtemplate","openApiOperationId":"deleteBatchTemplate","summary":"Returns a batch template from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The batch template was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}},"schemaId":"schema_409","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The batch template could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The batch template could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to delete batch template based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1batchTemplates~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_409","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/batch-templates/deletebatchtemplate"}],"panels":[]}]},"httpPath":"/batchTemplates/{tenantId}/{id}"},{"label":"Returns a batch template from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/batch-templates/getbatchtemplate","routeSlug":"/apis/collect/collect-v1/batch-templates/getbatchtemplate","metadata":{"seo":{"title":"Returns a batch template from the system by its ID.","description":"This method will look up a batch template by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getBatchTemplate","name":"Returns a batch template from the system by its ID.","isWebhook":false,"pointer":"/paths/~1batchTemplates~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a batch template from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a batch template by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the batch template to return.","required":true}],"pointer":"/paths/~1batchTemplates~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_409","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1batchTemplates~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/batchTemplates/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/batchTemplates/{tenantId}/{id}","href":"batch-templates/getbatchtemplate","openApiOperationId":"getBatchTemplate","summary":"Returns a batch template from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The batch template was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchTemplate"}},"schemaId":"components/schemas/BatchTemplate","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The batch template could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve batch template based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1batchTemplates~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchTemplate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchTemplate"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/batch-templates/getbatchtemplate"}],"panels":[]}]},"httpPath":"/batchTemplates/{tenantId}/{id}"},{"label":"Partially updates a batch template with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/batch-templates/patchbatchtemplate","routeSlug":"/apis/collect/collect-v1/batch-templates/patchbatchtemplate","metadata":{"seo":{"title":"Partially updates a batch template with the specified ID.","description":"This method will patch an existing batch template with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchBatchTemplate","name":"Partially updates a batch template with the specified ID.","isWebhook":false,"pointer":"/paths/~1batchTemplates~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a batch template with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing batch template with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the batch template to patch.","required":true}],"pointer":"/paths/~1batchTemplates~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"schemaId":"schema_412","pointer":"/paths/~1batchTemplates~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/batchTemplates/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_412"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/batchTemplates/{tenantId}/{id}","href":"batch-templates/patchbatchtemplate","openApiOperationId":"patchBatchTemplate","summary":"Partially updates a batch template with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"schema_412","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The batch template was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchTemplate"}},"schemaId":"components/schemas/BatchTemplate","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The batch template could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The batch template could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve batch template based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1batchTemplates~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchTemplate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchTemplate"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/batch-templates/patchbatchtemplate"}],"panels":[]}]},"httpPath":"/batchTemplates/{tenantId}/{id}"},{"label":"Updates a batch template with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/batch-templates/updatebatchtemplate","routeSlug":"/apis/collect/collect-v1/batch-templates/updatebatchtemplate","metadata":{"seo":{"title":"Updates a batch template with the specified ID.","description":"This method will update an existing batch template with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateBatchTemplate","name":"Updates a batch template with the specified ID.","isWebhook":false,"pointer":"/paths/~1batchTemplates~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a batch template with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing batch template with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the batch template to update.","required":true}],"pointer":"/paths/~1batchTemplates~1{tenantId}~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/BatchTemplate"}},"schemaId":"components/schemas/BatchTemplate","pointer":"/paths/~1batchTemplates~1{tenantId}~1{id}/put/requestBody","description":"The updated batch template that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/batchTemplates/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchTemplate"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/batchTemplates/{tenantId}/{id}","href":"batch-templates/updatebatchtemplate","openApiOperationId":"updateBatchTemplate","summary":"Updates a batch template with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchTemplate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchTemplate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The batch template was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchTemplate"}},"schemaId":"components/schemas/BatchTemplate","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The batch template supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The batch template could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The batch template could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve batch template based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1batchTemplates~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchTemplate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchTemplate"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/batch-templates/updatebatchtemplate"}],"panels":[]}]},"httpPath":"/batchTemplates/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Batch Templates"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Batch Templates","showPageActions":true},{"nodeType":"markdoc","content":"Batch Templates"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/batchTemplates/{tenantId}","summary":"Gets all of the batch templates in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/batch-templates/listbatchtemplates","deprecated":false},{"title":"/batchTemplates/{tenantId}","summary":"Creates a new batch template record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/batch-templates/createbatchtemplate","deprecated":false},{"title":"/batchTemplates/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/batch-templates/executebatchoperations","deprecated":false},{"title":"/batchTemplates/{tenantId}/{id}","summary":"Returns a batch template from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/batch-templates/deletebatchtemplate","deprecated":false},{"title":"/batchTemplates/{tenantId}/{id}","summary":"Returns a batch template from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/batch-templates/getbatchtemplate","deprecated":false},{"title":"/batchTemplates/{tenantId}/{id}","summary":"Partially updates a batch template with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/batch-templates/patchbatchtemplate","deprecated":false},{"title":"/batchTemplates/{tenantId}/{id}","summary":"Updates a batch template with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/batch-templates/updatebatchtemplate","deprecated":false}]}]}]}]}},{"type":"group","label":"Batches","link":"/apis/collect/collect-v1/batches","routeSlug":"/apis/collect/collect-v1/batches","items":[{"label":"Gets all of the batches in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/batches/listbatches","routeSlug":"/apis/collect/collect-v1/batches/listbatches","metadata":{"seo":{"title":"Gets all of the batches in the system.","description":"This method will scan all batches and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listBatches","name":"Gets all of the batches in the system.","isWebhook":false,"pointer":"/paths/~1batches~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the batches in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all batches and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1batches~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1batches~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/batches/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/batches/{tenantId}","href":"batches/listbatches","openApiOperationId":"listBatches","summary":"Gets all of the batches in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The batcheswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_417"}},"schemaId":"schema_417","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1batches~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_417","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_417"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/batches/listbatches"}],"panels":[]}]},"httpPath":"/batches/{tenantId}"},{"label":"Creates a new batch record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/batches/createbatch","routeSlug":"/apis/collect/collect-v1/batches/createbatch","metadata":{"seo":{"title":"Creates a new batch record that does not already exist.","description":"This method will auto-generate an ID and create a new batch. If an ID is specified for the batch, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createBatch","name":"Creates a new batch record that does not already exist.","isWebhook":false,"pointer":"/paths/~1batches~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new batch record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new batch. If an ID is specified for the batch, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1batches~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Batch"}},"schemaId":"components/schemas/Batch","pointer":"/paths/~1batches~1{tenantId}/post/requestBody","description":"The batch that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/batches/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Batch"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/batches/{tenantId}","href":"batches/createbatch","openApiOperationId":"createBatch","summary":"Creates a new batch record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Batch","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Batch"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The batch was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Batch"}},"schemaId":"components/schemas/Batch","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The batch you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The batch could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add batch based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1batches~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Batch","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Batch"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/batches/createbatch"}],"panels":[]}]},"httpPath":"/batches/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/batches/executebatchoperations","routeSlug":"/apis/collect/collect-v1/batches/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1batches~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1batches~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1batches~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/batches/{tenantId}/batch","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/batches/{tenantId}/batch","href":"batches/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The batch could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve batch based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1batches~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/batches/executebatchoperations"}],"panels":[]}]},"httpPath":"/batches/{tenantId}/batch"},{"label":"Recursively retrieve batches dependent on a set of batches","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/batches/recursivelyretrievedependentbatches","routeSlug":"/apis/collect/collect-v1/batches/recursivelyretrievedependentbatches","metadata":{"seo":{"title":"Recursively retrieve batches dependent on a set of batches","description":"Returns a list of child batches dependent on the batches specified"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"recursivelyRetrieveDependentBatches","name":"Recursively retrieve batches dependent on a set of batches","isWebhook":false,"pointer":"/paths/~1batches~1{tenantId}~1dependents/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Recursively retrieve batches dependent on a set of batches","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 child batches dependent on the batches specified"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The tenant","required":true}],"pointer":"/paths/~1batches~1{tenantId}~1dependents/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"ids","in":"query","schemaId":"schema_409","description":"The batch IDs","required":true}],"pointer":"/paths/~1batches~1{tenantId}~1dependents/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/batches/{tenantId}/dependents","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"ids","in":"query","required":true,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/batches/{tenantId}/dependents","href":"batches/recursivelyretrievedependentbatches","openApiOperationId":"recursivelyRetrieveDependentBatches","summary":"Recursively retrieve batches dependent on a set of batches"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DependentBatchResponse"}},"schemaId":"components/schemas/DependentBatchResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1batches~1{tenantId}~1dependents/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DependentBatchResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DependentBatchResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/batches/recursivelyretrievedependentbatches"}],"panels":[]}]},"httpPath":"/batches/{tenantId}/dependents"},{"label":"Returns a list of records with the specified fiscal_year_id and fiscal_period","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/batches/listbatchesbyfiscalperiod","routeSlug":"/apis/collect/collect-v1/batches/listbatchesbyfiscalperiod","metadata":{"seo":{"title":"Returns a list of records with the specified fiscal_year_id and fiscal_period","description":"Returns a list of records with the specified fiscal_year_id and fiscal_period"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listBatchesByFiscalPeriod","name":"Returns a list of records with the specified fiscal_year_id and fiscal_period","isWebhook":false,"pointer":"/paths/~1batches~1{tenantId}~1fiscal_period~1{fiscal_year_id}~1{fiscal_period}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified fiscal_year_id and fiscal_period","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 records with the specified fiscal_year_id and fiscal_period"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The tenant","required":true},{"name":"fiscal_year_id","in":"path","schemaId":"schema_409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The fiscal_year_id to use to for record lookup"},"children":[]}]}]}],"required":true},{"name":"fiscal_period","in":"path","schemaId":"schema_409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The fiscal_period to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1batches~1{tenantId}~1fiscal_period~1{fiscal_year_id}~1{fiscal_period}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned"}],"pointer":"/paths/~1batches~1{tenantId}~1fiscal_period~1{fiscal_year_id}~1{fiscal_period}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/batches/{tenantId}/fiscal_period/{fiscal_year_id}/{fiscal_period}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"fiscal_year_id","in":"path","required":true,"schemaId":"schema_409"},{"name":"fiscal_period","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/batches/{tenantId}/fiscal_period/{fiscal_year_id}/{fiscal_period}","href":"batches/listbatchesbyfiscalperiod","openApiOperationId":"listBatchesByFiscalPeriod","summary":"Returns a list of records with the specified fiscal_year_id and fiscal_period"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListBatchesResponse"}},"schemaId":"components/schemas/ListBatchesResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1batches~1{tenantId}~1fiscal_period~1{fiscal_year_id}~1{fiscal_period}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListBatchesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListBatchesResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/batches/listbatchesbyfiscalperiod"}],"panels":[]}]},"httpPath":"/batches/{tenantId}/fiscal_period/{fiscal_year_id}/{fiscal_period}"},{"label":"Searches for batches using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/batches/searchforbatches","routeSlug":"/apis/collect/collect-v1/batches/searchforbatches","metadata":{"seo":{"title":"Searches for batches using predefined parameters","description":"Searches for batches using predefined parameters"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchForBatches","name":"Searches for batches using predefined parameters","isWebhook":false,"pointer":"/paths/~1batches~1{tenantId}~1search/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Searches for batches using predefined parameters","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Searches for batches using predefined parameters"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1batches~1{tenantId}~1search/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"The start key for the search, for paging support"},{"name":"fieldsToReturn","in":"query","schemaId":"schema_409","description":"  The fields that you want to retrieve; if omitted, the entire object is returned"}],"pointer":"/paths/~1batches~1{tenantId}~1search/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchSearchParameters"}},"schemaId":"components/schemas/BatchSearchParameters","pointer":"/paths/~1batches~1{tenantId}~1search/post/requestBody","description":"The batch that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/batches/{tenantId}/search","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"},{"name":"fieldsToReturn","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchSearchParameters"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/batches/{tenantId}/search","href":"batches/searchforbatches","openApiOperationId":"searchForBatches","summary":"Searches for batches using predefined parameters"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchSearchParameters","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchSearchParameters"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The batch search was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedBatchSearchResults"}},"schemaId":"components/schemas/PagedBatchSearchResults","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The batch you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The batch could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add batch based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1batches~1{tenantId}~1search/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PagedBatchSearchResults","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedBatchSearchResults"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/batches/searchforbatches"}],"panels":[]}]},"httpPath":"/batches/{tenantId}/search"},{"label":"Returns a list of records with the specified status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/batches/listbatchesbystatus","routeSlug":"/apis/collect/collect-v1/batches/listbatchesbystatus","metadata":{"seo":{"title":"Returns a list of records with the specified status","description":"Returns a list of records with the specified status"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listBatchesByStatus","name":"Returns a list of records with the specified status","isWebhook":false,"pointer":"/paths/~1batches~1{tenantId}~1status~1{status}~1{businessUnitId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified status","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 records with the specified status"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The tenant","required":true},{"name":"businessUnitId","in":"path","schemaId":"schema_409","description":"The business unt","required":true},{"name":"status","in":"path","schemaId":"schema_409","description":"The status to use to for record lookup","required":true}],"pointer":"/paths/~1batches~1{tenantId}~1status~1{status}~1{businessUnitId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned"}],"pointer":"/paths/~1batches~1{tenantId}~1status~1{status}~1{businessUnitId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/batches/{tenantId}/status/{status}/{businessUnitId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"businessUnitId","in":"path","required":true,"schemaId":"schema_409"},{"name":"status","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/batches/{tenantId}/status/{status}/{businessUnitId}","href":"batches/listbatchesbystatus","openApiOperationId":"listBatchesByStatus","summary":"Returns a list of records with the specified status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListBatchesResponse"}},"schemaId":"components/schemas/ListBatchesResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1batches~1{tenantId}~1status~1{status}~1{businessUnitId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListBatchesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListBatchesResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/batches/listbatchesbystatus"}],"panels":[]}]},"httpPath":"/batches/{tenantId}/status/{status}/{businessUnitId}"},{"label":"Returns a batch from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/batches/deletebatch","routeSlug":"/apis/collect/collect-v1/batches/deletebatch","metadata":{"seo":{"title":"Returns a batch from the system by its ID.","description":"This method will delete a batch with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteBatch","name":"Returns a batch from the system by its ID.","isWebhook":false,"pointer":"/paths/~1batches~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a batch from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a batch with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the batch to delete.","required":true}],"pointer":"/paths/~1batches~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/batches/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/batches/{tenantId}/{id}","href":"batches/deletebatch","openApiOperationId":"deleteBatch","summary":"Returns a batch from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The batch was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}},"schemaId":"schema_409","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The batch could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The batch could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to delete batch based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1batches~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_409","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/batches/deletebatch"}],"panels":[]}]},"httpPath":"/batches/{tenantId}/{id}"},{"label":"Returns a batch from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/batches/getbatch","routeSlug":"/apis/collect/collect-v1/batches/getbatch","metadata":{"seo":{"title":"Returns a batch from the system by its ID.","description":"This method will look up a batch by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getBatch","name":"Returns a batch from the system by its ID.","isWebhook":false,"pointer":"/paths/~1batches~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a batch from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a batch by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the batch to return.","required":true}],"pointer":"/paths/~1batches~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_409","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1batches~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/batches/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/batches/{tenantId}/{id}","href":"batches/getbatch","openApiOperationId":"getBatch","summary":"Returns a batch from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The batch was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Batch"}},"schemaId":"components/schemas/Batch","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The batch could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve batch based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1batches~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Batch","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Batch"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/batches/getbatch"}],"panels":[]}]},"httpPath":"/batches/{tenantId}/{id}"},{"label":"Partially updates a batch with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/batches/patchbatch","routeSlug":"/apis/collect/collect-v1/batches/patchbatch","metadata":{"seo":{"title":"Partially updates a batch with the specified ID.","description":"This method will patch an existing batch with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchBatch","name":"Partially updates a batch with the specified ID.","isWebhook":false,"pointer":"/paths/~1batches~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a batch with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing batch with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the batch to patch.","required":true}],"pointer":"/paths/~1batches~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"schemaId":"schema_412","pointer":"/paths/~1batches~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/batches/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_412"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/batches/{tenantId}/{id}","href":"batches/patchbatch","openApiOperationId":"patchBatch","summary":"Partially updates a batch with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"schema_412","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The batch was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Batch"}},"schemaId":"components/schemas/Batch","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The batch could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The batch could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve batch based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1batches~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Batch","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Batch"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/batches/patchbatch"}],"panels":[]}]},"httpPath":"/batches/{tenantId}/{id}"},{"label":"Updates a batch with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/batches/updatebatch","routeSlug":"/apis/collect/collect-v1/batches/updatebatch","metadata":{"seo":{"title":"Updates a batch with the specified ID.","description":"This method will update an existing batch with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateBatch","name":"Updates a batch with the specified ID.","isWebhook":false,"pointer":"/paths/~1batches~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a batch with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing batch with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the batch to update.","required":true}],"pointer":"/paths/~1batches~1{tenantId}~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/Batch"}},"schemaId":"components/schemas/Batch","pointer":"/paths/~1batches~1{tenantId}~1{id}/put/requestBody","description":"The updated batch that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/batches/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Batch"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/batches/{tenantId}/{id}","href":"batches/updatebatch","openApiOperationId":"updateBatch","summary":"Updates a batch with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Batch","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Batch"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The batch was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Batch"}},"schemaId":"components/schemas/Batch","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The batch supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The batch could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The batch could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve batch based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1batches~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Batch","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Batch"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/batches/updatebatch"}],"panels":[]}]},"httpPath":"/batches/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Batches"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Batches","showPageActions":true},{"nodeType":"markdoc","content":"Batches"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/batches/{tenantId}","summary":"Gets all of the batches in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/batches/listbatches","deprecated":false},{"title":"/batches/{tenantId}","summary":"Creates a new batch record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/batches/createbatch","deprecated":false},{"title":"/batches/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/batches/executebatchoperations","deprecated":false},{"title":"/batches/{tenantId}/dependents","summary":"Recursively retrieve batches dependent on a set of batches","prefix":{"name":"get","color":"get"},"badges":[],"link":"/batches/recursivelyretrievedependentbatches","deprecated":false},{"title":"/batches/{tenantId}/fiscal_period/{fiscal_year_id}/{fiscal_period}","summary":"Returns a list of records with the specified fiscal_year_id and fiscal_period","prefix":{"name":"get","color":"get"},"badges":[],"link":"/batches/listbatchesbyfiscalperiod","deprecated":false},{"title":"/batches/{tenantId}/search","summary":"Searches for batches using predefined parameters","prefix":{"name":"post","color":"post"},"badges":[],"link":"/batches/searchforbatches","deprecated":false},{"title":"/batches/{tenantId}/status/{status}/{businessUnitId}","summary":"Returns a list of records with the specified status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/batches/listbatchesbystatus","deprecated":false},{"title":"/batches/{tenantId}/{id}","summary":"Returns a batch from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/batches/deletebatch","deprecated":false},{"title":"/batches/{tenantId}/{id}","summary":"Returns a batch from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/batches/getbatch","deprecated":false},{"title":"/batches/{tenantId}/{id}","summary":"Partially updates a batch with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/batches/patchbatch","deprecated":false},{"title":"/batches/{tenantId}/{id}","summary":"Updates a batch with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/batches/updatebatch","deprecated":false}]}]}]}]}},{"type":"group","label":"Billing Notices","link":"/apis/collect/collect-v1/billing-notices","routeSlug":"/apis/collect/collect-v1/billing-notices","items":[{"label":"Gets all of the billing notices in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/billing-notices/listbillingnotices","routeSlug":"/apis/collect/collect-v1/billing-notices/listbillingnotices","metadata":{"seo":{"title":"Gets all of the billing notices in the system.","description":"This method will scan all billing notices and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listBillingNotices","name":"Gets all of the billing notices in the system.","isWebhook":false,"pointer":"/paths/~1billingNotices~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the billing notices in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all billing notices and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1billingNotices~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1billingNotices~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/billingNotices/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/billingNotices/{tenantId}","href":"billing-notices/listbillingnotices","openApiOperationId":"listBillingNotices","summary":"Gets all of the billing notices in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The billing noticeswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_418"}},"schemaId":"schema_418","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1billingNotices~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_418","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_418"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/billing-notices/listbillingnotices"}],"panels":[]}]},"httpPath":"/billingNotices/{tenantId}"},{"label":"Creates a new billing notice record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/billing-notices/createbillingnotice","routeSlug":"/apis/collect/collect-v1/billing-notices/createbillingnotice","metadata":{"seo":{"title":"Creates a new billing notice record that does not already exist.","description":"This method will auto-generate an ID and create a new billing notice. If an ID is specified for the billing notice, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createBillingNotice","name":"Creates a new billing notice record that does not already exist.","isWebhook":false,"pointer":"/paths/~1billingNotices~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new billing notice record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new billing notice. If an ID is specified for the billing notice, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1billingNotices~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BillingNotice"}},"schemaId":"components/schemas/BillingNotice","pointer":"/paths/~1billingNotices~1{tenantId}/post/requestBody","description":"The billing notice that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/billingNotices/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BillingNotice"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/billingNotices/{tenantId}","href":"billing-notices/createbillingnotice","openApiOperationId":"createBillingNotice","summary":"Creates a new billing notice record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BillingNotice","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BillingNotice"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The billing notice was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BillingNotice"}},"schemaId":"components/schemas/BillingNotice","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The billing notice you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The billing notice could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add billing notice based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1billingNotices~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BillingNotice","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BillingNotice"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/billing-notices/createbillingnotice"}],"panels":[]}]},"httpPath":"/billingNotices/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/billing-notices/executebatchoperations","routeSlug":"/apis/collect/collect-v1/billing-notices/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1billingNotices~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1billingNotices~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1billingNotices~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/billingNotices/{tenantId}/batch","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/billingNotices/{tenantId}/batch","href":"billing-notices/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The billing notice could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve billing notice based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1billingNotices~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/billing-notices/executebatchoperations"}],"panels":[]}]},"httpPath":"/billingNotices/{tenantId}/batch"},{"label":"Returns a billing notice from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/billing-notices/deletebillingnotice","routeSlug":"/apis/collect/collect-v1/billing-notices/deletebillingnotice","metadata":{"seo":{"title":"Returns a billing notice from the system by its ID.","description":"This method will delete a billing notice with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteBillingNotice","name":"Returns a billing notice from the system by its ID.","isWebhook":false,"pointer":"/paths/~1billingNotices~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a billing notice from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a billing notice with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the billing notice to delete.","required":true}],"pointer":"/paths/~1billingNotices~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/billingNotices/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/billingNotices/{tenantId}/{id}","href":"billing-notices/deletebillingnotice","openApiOperationId":"deleteBillingNotice","summary":"Returns a billing notice from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The billing notice was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}},"schemaId":"schema_409","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The billing notice could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The billing notice could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to delete billing notice based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1billingNotices~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_409","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/billing-notices/deletebillingnotice"}],"panels":[]}]},"httpPath":"/billingNotices/{tenantId}/{id}"},{"label":"Returns a billing notice from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/billing-notices/getbillingnotice","routeSlug":"/apis/collect/collect-v1/billing-notices/getbillingnotice","metadata":{"seo":{"title":"Returns a billing notice from the system by its ID.","description":"This method will look up a billing notice by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getBillingNotice","name":"Returns a billing notice from the system by its ID.","isWebhook":false,"pointer":"/paths/~1billingNotices~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a billing notice from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a billing notice by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the billing notice to return.","required":true}],"pointer":"/paths/~1billingNotices~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_409","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1billingNotices~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/billingNotices/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/billingNotices/{tenantId}/{id}","href":"billing-notices/getbillingnotice","openApiOperationId":"getBillingNotice","summary":"Returns a billing notice from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The billing notice was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BillingNotice"}},"schemaId":"components/schemas/BillingNotice","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The billing notice could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve billing notice based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1billingNotices~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BillingNotice","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BillingNotice"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/billing-notices/getbillingnotice"}],"panels":[]}]},"httpPath":"/billingNotices/{tenantId}/{id}"},{"label":"Partially updates a billing notice with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/billing-notices/patchbillingnotice","routeSlug":"/apis/collect/collect-v1/billing-notices/patchbillingnotice","metadata":{"seo":{"title":"Partially updates a billing notice with the specified ID.","description":"This method will patch an existing billing notice with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchBillingNotice","name":"Partially updates a billing notice with the specified ID.","isWebhook":false,"pointer":"/paths/~1billingNotices~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a billing notice with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing billing notice with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the billing notice to patch.","required":true}],"pointer":"/paths/~1billingNotices~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"schemaId":"schema_412","pointer":"/paths/~1billingNotices~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/billingNotices/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_412"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/billingNotices/{tenantId}/{id}","href":"billing-notices/patchbillingnotice","openApiOperationId":"patchBillingNotice","summary":"Partially updates a billing notice with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"schema_412","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The billing notice was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BillingNotice"}},"schemaId":"components/schemas/BillingNotice","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The billing notice could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The billing notice could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve billing notice based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1billingNotices~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BillingNotice","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BillingNotice"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/billing-notices/patchbillingnotice"}],"panels":[]}]},"httpPath":"/billingNotices/{tenantId}/{id}"},{"label":"Updates a billing notice with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/billing-notices/updatebillingnotice","routeSlug":"/apis/collect/collect-v1/billing-notices/updatebillingnotice","metadata":{"seo":{"title":"Updates a billing notice with the specified ID.","description":"This method will update an existing billing notice with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateBillingNotice","name":"Updates a billing notice with the specified ID.","isWebhook":false,"pointer":"/paths/~1billingNotices~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a billing notice with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing billing notice with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the billing notice to update.","required":true}],"pointer":"/paths/~1billingNotices~1{tenantId}~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/BillingNotice"}},"schemaId":"components/schemas/BillingNotice","pointer":"/paths/~1billingNotices~1{tenantId}~1{id}/put/requestBody","description":"The updated billing notice that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/billingNotices/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BillingNotice"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/billingNotices/{tenantId}/{id}","href":"billing-notices/updatebillingnotice","openApiOperationId":"updateBillingNotice","summary":"Updates a billing notice with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BillingNotice","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BillingNotice"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The billing notice was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BillingNotice"}},"schemaId":"components/schemas/BillingNotice","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The billing notice supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The billing notice could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The billing notice could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve billing notice based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1billingNotices~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BillingNotice","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BillingNotice"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/billing-notices/updatebillingnotice"}],"panels":[]}]},"httpPath":"/billingNotices/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Billing Notices"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Billing Notices","showPageActions":true},{"nodeType":"markdoc","content":"Billing Notices"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/billingNotices/{tenantId}","summary":"Gets all of the billing notices in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/billing-notices/listbillingnotices","deprecated":false},{"title":"/billingNotices/{tenantId}","summary":"Creates a new billing notice record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/billing-notices/createbillingnotice","deprecated":false},{"title":"/billingNotices/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/billing-notices/executebatchoperations","deprecated":false},{"title":"/billingNotices/{tenantId}/{id}","summary":"Returns a billing notice from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/billing-notices/deletebillingnotice","deprecated":false},{"title":"/billingNotices/{tenantId}/{id}","summary":"Returns a billing notice from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/billing-notices/getbillingnotice","deprecated":false},{"title":"/billingNotices/{tenantId}/{id}","summary":"Partially updates a billing notice with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/billing-notices/patchbillingnotice","deprecated":false},{"title":"/billingNotices/{tenantId}/{id}","summary":"Updates a billing notice with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/billing-notices/updatebillingnotice","deprecated":false}]}]}]}]}},{"type":"group","label":"Billing Run Actions","link":"/apis/collect/collect-v1/billing-run-actions","routeSlug":"/apis/collect/collect-v1/billing-run-actions","items":[{"label":"Creates a new billing run action record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/billing-run-actions/createbillingrunaction","routeSlug":"/apis/collect/collect-v1/billing-run-actions/createbillingrunaction","metadata":{"seo":{"title":"Creates a new billing run action record that does not already exist.","description":"This method will auto-generate an ID and create a new billing run action. If an ID is specified for the billing run action, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createBillingRunAction","name":"Creates a new billing run action record that does not already exist.","isWebhook":false,"pointer":"/paths/~1billingRunActions~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new billing run action record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new billing run action. If an ID is specified for the billing run action, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1billingRunActions~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BillingRunAction"}},"schemaId":"components/schemas/BillingRunAction","pointer":"/paths/~1billingRunActions~1{tenantId}/post/requestBody","description":"The billing run action that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/billingRunActions/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BillingRunAction"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/billingRunActions/{tenantId}","href":"billing-run-actions/createbillingrunaction","openApiOperationId":"createBillingRunAction","summary":"Creates a new billing run action record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BillingRunAction","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BillingRunAction"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The billing run action was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BillingRunAction"}},"schemaId":"components/schemas/BillingRunAction","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The billing run action you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The billing run action could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add billing run action based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1billingRunActions~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BillingRunAction","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BillingRunAction"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/billing-run-actions/createbillingrunaction"}],"panels":[]}]},"httpPath":"/billingRunActions/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/billing-run-actions/executebatchoperations","routeSlug":"/apis/collect/collect-v1/billing-run-actions/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1billingRunActions~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1billingRunActions~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1billingRunActions~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/billingRunActions/{tenantId}/batch","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/billingRunActions/{tenantId}/batch","href":"billing-run-actions/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The billing run action could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve billing run action based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1billingRunActions~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/billing-run-actions/executebatchoperations"}],"panels":[]}]},"httpPath":"/billingRunActions/{tenantId}/batch"},{"label":"Returns a list of records with the specified billing_run_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/billing-run-actions/listactionsbybillingrunid","routeSlug":"/apis/collect/collect-v1/billing-run-actions/listactionsbybillingrunid","metadata":{"seo":{"title":"Returns a list of records with the specified billing_run_id","description":"Returns a list of records with the specified billing_run_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listActionsByBillingRunId","name":"Returns a list of records with the specified billing_run_id","isWebhook":false,"pointer":"/paths/~1billingRunActions~1{tenantId}~1billingRun~1{billing_run_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified billing_run_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":"Returns a list of records with the specified billing_run_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The tenant","required":true},{"name":"billing_run_id","in":"path","schemaId":"schema_409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The billing_run_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1billingRunActions~1{tenantId}~1billingRun~1{billing_run_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1billingRunActions~1{tenantId}~1billingRun~1{billing_run_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/billingRunActions/{tenantId}/billingRun/{billing_run_id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"billing_run_id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/billingRunActions/{tenantId}/billingRun/{billing_run_id}","href":"billing-run-actions/listactionsbybillingrunid","openApiOperationId":"listActionsByBillingRunId","summary":"Returns a list of records with the specified billing_run_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListBillingRunActionsResponse"}},"schemaId":"components/schemas/ListBillingRunActionsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1billingRunActions~1{tenantId}~1billingRun~1{billing_run_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListBillingRunActionsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListBillingRunActionsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/billing-run-actions/listactionsbybillingrunid"}],"panels":[]}]},"httpPath":"/billingRunActions/{tenantId}/billingRun/{billing_run_id}"},{"label":"Returns a billing run action from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/billing-run-actions/deletebillingrunaction","routeSlug":"/apis/collect/collect-v1/billing-run-actions/deletebillingrunaction","metadata":{"seo":{"title":"Returns a billing run action from the system by its ID.","description":"This method will delete a billing run action with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteBillingRunAction","name":"Returns a billing run action from the system by its ID.","isWebhook":false,"pointer":"/paths/~1billingRunActions~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a billing run action from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a billing run action with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the billing run action to delete.","required":true}],"pointer":"/paths/~1billingRunActions~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/billingRunActions/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/billingRunActions/{tenantId}/{id}","href":"billing-run-actions/deletebillingrunaction","openApiOperationId":"deleteBillingRunAction","summary":"Returns a billing run action from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The billing run action was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}},"schemaId":"schema_409","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The billing run action could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The billing run action could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to delete billing run action based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1billingRunActions~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_409","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/billing-run-actions/deletebillingrunaction"}],"panels":[]}]},"httpPath":"/billingRunActions/{tenantId}/{id}"},{"label":"Returns a billing run action from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/billing-run-actions/getbillingrunaction","routeSlug":"/apis/collect/collect-v1/billing-run-actions/getbillingrunaction","metadata":{"seo":{"title":"Returns a billing run action from the system by its ID.","description":"This method will look up a billing run action by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getBillingRunAction","name":"Returns a billing run action from the system by its ID.","isWebhook":false,"pointer":"/paths/~1billingRunActions~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a billing run action from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a billing run action by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the billing run action to return.","required":true}],"pointer":"/paths/~1billingRunActions~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_409","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1billingRunActions~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/billingRunActions/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/billingRunActions/{tenantId}/{id}","href":"billing-run-actions/getbillingrunaction","openApiOperationId":"getBillingRunAction","summary":"Returns a billing run action from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The billing run action was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BillingRunAction"}},"schemaId":"components/schemas/BillingRunAction","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The billing run action could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve billing run action based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1billingRunActions~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BillingRunAction","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BillingRunAction"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/billing-run-actions/getbillingrunaction"}],"panels":[]}]},"httpPath":"/billingRunActions/{tenantId}/{id}"},{"label":"Partially updates a billing run action with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/billing-run-actions/patchbillingrunaction","routeSlug":"/apis/collect/collect-v1/billing-run-actions/patchbillingrunaction","metadata":{"seo":{"title":"Partially updates a billing run action with the specified ID.","description":"This method will patch an existing billing run action with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchBillingRunAction","name":"Partially updates a billing run action with the specified ID.","isWebhook":false,"pointer":"/paths/~1billingRunActions~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a billing run action with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing billing run action with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the billing run action to patch.","required":true}],"pointer":"/paths/~1billingRunActions~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"schemaId":"schema_412","pointer":"/paths/~1billingRunActions~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/billingRunActions/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_412"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/billingRunActions/{tenantId}/{id}","href":"billing-run-actions/patchbillingrunaction","openApiOperationId":"patchBillingRunAction","summary":"Partially updates a billing run action with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"schema_412","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The billing run action was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BillingRunAction"}},"schemaId":"components/schemas/BillingRunAction","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The billing run action could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The billing run action could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve billing run action based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1billingRunActions~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BillingRunAction","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BillingRunAction"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/billing-run-actions/patchbillingrunaction"}],"panels":[]}]},"httpPath":"/billingRunActions/{tenantId}/{id}"},{"label":"Updates a billing run action with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/billing-run-actions/updatebillingrunaction","routeSlug":"/apis/collect/collect-v1/billing-run-actions/updatebillingrunaction","metadata":{"seo":{"title":"Updates a billing run action with the specified ID.","description":"This method will update an existing billing run action with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateBillingRunAction","name":"Updates a billing run action with the specified ID.","isWebhook":false,"pointer":"/paths/~1billingRunActions~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a billing run action with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing billing run action with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the billing run action to update.","required":true}],"pointer":"/paths/~1billingRunActions~1{tenantId}~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/BillingRunAction"}},"schemaId":"components/schemas/BillingRunAction","pointer":"/paths/~1billingRunActions~1{tenantId}~1{id}/put/requestBody","description":"The updated billing run action that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/billingRunActions/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BillingRunAction"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/billingRunActions/{tenantId}/{id}","href":"billing-run-actions/updatebillingrunaction","openApiOperationId":"updateBillingRunAction","summary":"Updates a billing run action with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BillingRunAction","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BillingRunAction"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The billing run action was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BillingRunAction"}},"schemaId":"components/schemas/BillingRunAction","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The billing run action supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The billing run action could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The billing run action could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve billing run action based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1billingRunActions~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BillingRunAction","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BillingRunAction"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/billing-run-actions/updatebillingrunaction"}],"panels":[]}]},"httpPath":"/billingRunActions/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Billing Run Actions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Billing Run Actions","showPageActions":true},{"nodeType":"markdoc","content":"Billing Run Actions"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/billingRunActions/{tenantId}","summary":"Creates a new billing run action record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/billing-run-actions/createbillingrunaction","deprecated":false},{"title":"/billingRunActions/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/billing-run-actions/executebatchoperations","deprecated":false},{"title":"/billingRunActions/{tenantId}/billingRun/{billing_run_id}","summary":"Returns a list of records with the specified billing_run_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/billing-run-actions/listactionsbybillingrunid","deprecated":false},{"title":"/billingRunActions/{tenantId}/{id}","summary":"Returns a billing run action from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/billing-run-actions/deletebillingrunaction","deprecated":false},{"title":"/billingRunActions/{tenantId}/{id}","summary":"Returns a billing run action from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/billing-run-actions/getbillingrunaction","deprecated":false},{"title":"/billingRunActions/{tenantId}/{id}","summary":"Partially updates a billing run action with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/billing-run-actions/patchbillingrunaction","deprecated":false},{"title":"/billingRunActions/{tenantId}/{id}","summary":"Updates a billing run action with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/billing-run-actions/updatebillingrunaction","deprecated":false}]}]}]}]}},{"type":"group","label":"Billing Runs","link":"/apis/collect/collect-v1/billing-runs","routeSlug":"/apis/collect/collect-v1/billing-runs","items":[{"label":"Creates a new billing run record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/billing-runs/createbillingrun","routeSlug":"/apis/collect/collect-v1/billing-runs/createbillingrun","metadata":{"seo":{"title":"Creates a new billing run record that does not already exist.","description":"This method will auto-generate an ID and create a new billing run. If an ID is specified for the billing run, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createBillingRun","name":"Creates a new billing run record that does not already exist.","isWebhook":false,"pointer":"/paths/~1billingRuns~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new billing run record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new billing run. If an ID is specified for the billing run, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1billingRuns~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BillingRun"}},"schemaId":"components/schemas/BillingRun","pointer":"/paths/~1billingRuns~1{tenantId}/post/requestBody","description":"The billing run that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/billingRuns/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BillingRun"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/billingRuns/{tenantId}","href":"billing-runs/createbillingrun","openApiOperationId":"createBillingRun","summary":"Creates a new billing run record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BillingRun","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BillingRun"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The billing run was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BillingRun"}},"schemaId":"components/schemas/BillingRun","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The billing run you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The billing run could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add billing run based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1billingRuns~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BillingRun","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BillingRun"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/billing-runs/createbillingrun"}],"panels":[]}]},"httpPath":"/billingRuns/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/billing-runs/executebatchoperations","routeSlug":"/apis/collect/collect-v1/billing-runs/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1billingRuns~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1billingRuns~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1billingRuns~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/billingRuns/{tenantId}/batch","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/billingRuns/{tenantId}/batch","href":"billing-runs/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The billing run could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve billing run based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1billingRuns~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/billing-runs/executebatchoperations"}],"panels":[]}]},"httpPath":"/billingRuns/{tenantId}/batch"},{"label":"Generates a billing run from a template","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/billing-runs/generatebillingrunfromtemplate","routeSlug":"/apis/collect/collect-v1/billing-runs/generatebillingrunfromtemplate","metadata":{"seo":{"title":"Generates a billing run from a template","description":"Generates a billing run from a template"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"generateBillingRunFromTemplate","name":"Generates a billing run from a template","isWebhook":false,"pointer":"/paths/~1billingRuns~1{tenantId}~1fromTemplate~1{templateId}~1{referenceDate}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Generates a billing run from a template","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The tenant","required":true},{"name":"templateId","in":"path","schemaId":"schema_409","description":"The template","required":true},{"name":"referenceDate","in":"path","schemaId":"schema_409","description":"The reference date","required":true}],"pointer":"/paths/~1billingRuns~1{tenantId}~1fromTemplate~1{templateId}~1{referenceDate}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/billingRuns/{tenantId}/fromTemplate/{templateId}/{referenceDate}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"templateId","in":"path","required":true,"schemaId":"schema_409"},{"name":"referenceDate","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/billingRuns/{tenantId}/fromTemplate/{templateId}/{referenceDate}","href":"billing-runs/generatebillingrunfromtemplate","openApiOperationId":"generateBillingRunFromTemplate","summary":"Generates a billing run from a template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1billingRuns~1{tenantId}~1fromTemplate~1{templateId}~1{referenceDate}/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/billing-runs/generatebillingrunfromtemplate"}],"panels":[]}]},"httpPath":"/billingRuns/{tenantId}/fromTemplate/{templateId}/{referenceDate}"},{"label":"Returns a list of records with the specified recurring_billing_run_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/billing-runs/listrunsbyrecurringbillingrunid","routeSlug":"/apis/collect/collect-v1/billing-runs/listrunsbyrecurringbillingrunid","metadata":{"seo":{"title":"Returns a list of records with the specified recurring_billing_run_id","description":"Returns a list of records with the specified recurring_billing_run_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listRunsByRecurringBillingRunId","name":"Returns a list of records with the specified recurring_billing_run_id","isWebhook":false,"pointer":"/paths/~1billingRuns~1{tenantId}~1recurringBillingRun~1{recurring_billing_run_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified recurring_billing_run_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":"Returns a list of records with the specified recurring_billing_run_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The tenant","required":true},{"name":"recurring_billing_run_id","in":"path","schemaId":"schema_409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The recurring_billing_run_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1billingRuns~1{tenantId}~1recurringBillingRun~1{recurring_billing_run_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1billingRuns~1{tenantId}~1recurringBillingRun~1{recurring_billing_run_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/billingRuns/{tenantId}/recurringBillingRun/{recurring_billing_run_id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"recurring_billing_run_id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/billingRuns/{tenantId}/recurringBillingRun/{recurring_billing_run_id}","href":"billing-runs/listrunsbyrecurringbillingrunid","openApiOperationId":"listRunsByRecurringBillingRunId","summary":"Returns a list of records with the specified recurring_billing_run_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListBillingRunsResponse"}},"schemaId":"components/schemas/ListBillingRunsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1billingRuns~1{tenantId}~1recurringBillingRun~1{recurring_billing_run_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListBillingRunsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListBillingRunsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/billing-runs/listrunsbyrecurringbillingrunid"}],"panels":[]}]},"httpPath":"/billingRuns/{tenantId}/recurringBillingRun/{recurring_billing_run_id}"},{"label":"Refreshes a billing run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/billing-runs/refreshbillingrun","routeSlug":"/apis/collect/collect-v1/billing-runs/refreshbillingrun","metadata":{"seo":{"title":"Refreshes a billing run","description":"Refreshes a billing run"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"refreshBillingRun","name":"Refreshes a billing run","isWebhook":false,"pointer":"/paths/~1billingRuns~1{tenantId}~1refresh~1{id}/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Refreshes a billing run","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The tenant","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The billing_run_id to use to refresh"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1billingRuns~1{tenantId}~1refresh~1{id}/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/billingRuns/{tenantId}/refresh/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/billingRuns/{tenantId}/refresh/{id}","href":"billing-runs/refreshbillingrun","openApiOperationId":"refreshBillingRun","summary":"Refreshes a billing run"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StepFunctionExecutionToken"}},"schemaId":"components/schemas/StepFunctionExecutionToken","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1billingRuns~1{tenantId}~1refresh~1{id}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/StepFunctionExecutionToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StepFunctionExecutionToken"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/billing-runs/refreshbillingrun"}],"panels":[]}]},"httpPath":"/billingRuns/{tenantId}/refresh/{id}"},{"label":"Searches for billing runs using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/billing-runs/searchforbillingruns","routeSlug":"/apis/collect/collect-v1/billing-runs/searchforbillingruns","metadata":{"seo":{"title":"Searches for billing runs using predefined parameters","description":"Searches for billing runs using predefined parameters"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchForBillingRuns","name":"Searches for billing runs using predefined parameters","isWebhook":false,"pointer":"/paths/~1billingRuns~1{tenantId}~1search/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Searches for billing runs using predefined parameters","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Searches for billing runs using predefined parameters"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1billingRuns~1{tenantId}~1search/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"The start key for the search, for paging support"},{"name":"fieldsToReturn","in":"query","schemaId":"schema_409","description":"  The fields that you want to retrieve; if omitted, the entire object is returned"}],"pointer":"/paths/~1billingRuns~1{tenantId}~1search/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BillingRunSearchParameters"}},"schemaId":"components/schemas/BillingRunSearchParameters","pointer":"/paths/~1billingRuns~1{tenantId}~1search/post/requestBody","description":"The billing run that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/billingRuns/{tenantId}/search","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"},{"name":"fieldsToReturn","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BillingRunSearchParameters"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/billingRuns/{tenantId}/search","href":"billing-runs/searchforbillingruns","openApiOperationId":"searchForBillingRuns","summary":"Searches for billing runs using predefined parameters"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BillingRunSearchParameters","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BillingRunSearchParameters"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The billing run search was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedBillingRunSearchResults"}},"schemaId":"components/schemas/PagedBillingRunSearchResults","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The billing run you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The billing run could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add billing run based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1billingRuns~1{tenantId}~1search/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PagedBillingRunSearchResults","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedBillingRunSearchResults"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/billing-runs/searchforbillingruns"}],"panels":[]}]},"httpPath":"/billingRuns/{tenantId}/search"},{"label":"Returns a billing run from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/billing-runs/deletebillingrun","routeSlug":"/apis/collect/collect-v1/billing-runs/deletebillingrun","metadata":{"seo":{"title":"Returns a billing run from the system by its ID.","description":"This method will delete a billing run with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteBillingRun","name":"Returns a billing run from the system by its ID.","isWebhook":false,"pointer":"/paths/~1billingRuns~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a billing run from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a billing run with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the billing run to delete.","required":true}],"pointer":"/paths/~1billingRuns~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/billingRuns/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/billingRuns/{tenantId}/{id}","href":"billing-runs/deletebillingrun","openApiOperationId":"deleteBillingRun","summary":"Returns a billing run from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The billing run was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}},"schemaId":"schema_409","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The billing run could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The billing run could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to delete billing run based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1billingRuns~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_409","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/billing-runs/deletebillingrun"}],"panels":[]}]},"httpPath":"/billingRuns/{tenantId}/{id}"},{"label":"Returns a billing run from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/billing-runs/getbillingrun","routeSlug":"/apis/collect/collect-v1/billing-runs/getbillingrun","metadata":{"seo":{"title":"Returns a billing run from the system by its ID.","description":"This method will look up a billing run by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getBillingRun","name":"Returns a billing run from the system by its ID.","isWebhook":false,"pointer":"/paths/~1billingRuns~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a billing run from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a billing run by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the billing run to return.","required":true}],"pointer":"/paths/~1billingRuns~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_409","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1billingRuns~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/billingRuns/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/billingRuns/{tenantId}/{id}","href":"billing-runs/getbillingrun","openApiOperationId":"getBillingRun","summary":"Returns a billing run from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The billing run was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BillingRun"}},"schemaId":"components/schemas/BillingRun","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The billing run could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve billing run based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1billingRuns~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BillingRun","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BillingRun"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/billing-runs/getbillingrun"}],"panels":[]}]},"httpPath":"/billingRuns/{tenantId}/{id}"},{"label":"Partially updates a billing run with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/billing-runs/patchbillingrun","routeSlug":"/apis/collect/collect-v1/billing-runs/patchbillingrun","metadata":{"seo":{"title":"Partially updates a billing run with the specified ID.","description":"This method will patch an existing billing run with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchBillingRun","name":"Partially updates a billing run with the specified ID.","isWebhook":false,"pointer":"/paths/~1billingRuns~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a billing run with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing billing run with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the billing run to patch.","required":true}],"pointer":"/paths/~1billingRuns~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"schemaId":"schema_412","pointer":"/paths/~1billingRuns~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/billingRuns/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_412"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/billingRuns/{tenantId}/{id}","href":"billing-runs/patchbillingrun","openApiOperationId":"patchBillingRun","summary":"Partially updates a billing run with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"schema_412","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The billing run was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BillingRun"}},"schemaId":"components/schemas/BillingRun","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The billing run could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The billing run could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve billing run based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1billingRuns~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BillingRun","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BillingRun"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/billing-runs/patchbillingrun"}],"panels":[]}]},"httpPath":"/billingRuns/{tenantId}/{id}"},{"label":"Updates a billing run with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/billing-runs/updatebillingrun","routeSlug":"/apis/collect/collect-v1/billing-runs/updatebillingrun","metadata":{"seo":{"title":"Updates a billing run with the specified ID.","description":"This method will update an existing billing run with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateBillingRun","name":"Updates a billing run with the specified ID.","isWebhook":false,"pointer":"/paths/~1billingRuns~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a billing run with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing billing run with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the billing run to update.","required":true}],"pointer":"/paths/~1billingRuns~1{tenantId}~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/BillingRun"}},"schemaId":"components/schemas/BillingRun","pointer":"/paths/~1billingRuns~1{tenantId}~1{id}/put/requestBody","description":"The updated billing run that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/billingRuns/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BillingRun"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/billingRuns/{tenantId}/{id}","href":"billing-runs/updatebillingrun","openApiOperationId":"updateBillingRun","summary":"Updates a billing run with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BillingRun","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BillingRun"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The billing run was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BillingRun"}},"schemaId":"components/schemas/BillingRun","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The billing run supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The billing run could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The billing run could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve billing run based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1billingRuns~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BillingRun","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BillingRun"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/billing-runs/updatebillingrun"}],"panels":[]}]},"httpPath":"/billingRuns/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Billing Runs"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Billing Runs","showPageActions":true},{"nodeType":"markdoc","content":"Billing Runs"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/billingRuns/{tenantId}","summary":"Creates a new billing run record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/billing-runs/createbillingrun","deprecated":false},{"title":"/billingRuns/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/billing-runs/executebatchoperations","deprecated":false},{"title":"/billingRuns/{tenantId}/fromTemplate/{templateId}/{referenceDate}","summary":"Generates a billing run from a template","prefix":{"name":"get","color":"get"},"badges":[],"link":"/billing-runs/generatebillingrunfromtemplate","deprecated":false},{"title":"/billingRuns/{tenantId}/recurringBillingRun/{recurring_billing_run_id}","summary":"Returns a list of records with the specified recurring_billing_run_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/billing-runs/listrunsbyrecurringbillingrunid","deprecated":false},{"title":"/billingRuns/{tenantId}/refresh/{id}","summary":"Refreshes a billing run","prefix":{"name":"post","color":"post"},"badges":[],"link":"/billing-runs/refreshbillingrun","deprecated":false},{"title":"/billingRuns/{tenantId}/search","summary":"Searches for billing runs using predefined parameters","prefix":{"name":"post","color":"post"},"badges":[],"link":"/billing-runs/searchforbillingruns","deprecated":false},{"title":"/billingRuns/{tenantId}/{id}","summary":"Returns a billing run from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/billing-runs/deletebillingrun","deprecated":false},{"title":"/billingRuns/{tenantId}/{id}","summary":"Returns a billing run from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/billing-runs/getbillingrun","deprecated":false},{"title":"/billingRuns/{tenantId}/{id}","summary":"Partially updates a billing run with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/billing-runs/patchbillingrun","deprecated":false},{"title":"/billingRuns/{tenantId}/{id}","summary":"Updates a billing run with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/billing-runs/updatebillingrun","deprecated":false}]}]}]}]}},{"type":"group","label":"Billing Templates","link":"/apis/collect/collect-v1/billing-templates","routeSlug":"/apis/collect/collect-v1/billing-templates","items":[{"label":"Gets all of the billing templates in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/billing-templates/listbillingtemplates","routeSlug":"/apis/collect/collect-v1/billing-templates/listbillingtemplates","metadata":{"seo":{"title":"Gets all of the billing templates in the system.","description":"This method will scan all billing templates and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listBillingTemplates","name":"Gets all of the billing templates in the system.","isWebhook":false,"pointer":"/paths/~1billingTemplates~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the billing templates in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all billing templates and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1billingTemplates~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1billingTemplates~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/billingTemplates/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/billingTemplates/{tenantId}","href":"billing-templates/listbillingtemplates","openApiOperationId":"listBillingTemplates","summary":"Gets all of the billing templates in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The billing templateswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_419"}},"schemaId":"schema_419","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1billingTemplates~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_419","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_419"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/billing-templates/listbillingtemplates"}],"panels":[]}]},"httpPath":"/billingTemplates/{tenantId}"},{"label":"Creates a new billing template record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/billing-templates/createbillingtemplate","routeSlug":"/apis/collect/collect-v1/billing-templates/createbillingtemplate","metadata":{"seo":{"title":"Creates a new billing template record that does not already exist.","description":"This method will auto-generate an ID and create a new billing template. If an ID is specified for the billing template, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createBillingTemplate","name":"Creates a new billing template record that does not already exist.","isWebhook":false,"pointer":"/paths/~1billingTemplates~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new billing template record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new billing template. If an ID is specified for the billing template, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1billingTemplates~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BillingTemplate"}},"schemaId":"components/schemas/BillingTemplate","pointer":"/paths/~1billingTemplates~1{tenantId}/post/requestBody","description":"The billing template that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/billingTemplates/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BillingTemplate"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/billingTemplates/{tenantId}","href":"billing-templates/createbillingtemplate","openApiOperationId":"createBillingTemplate","summary":"Creates a new billing template record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BillingTemplate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BillingTemplate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The billing template was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BillingTemplate"}},"schemaId":"components/schemas/BillingTemplate","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The billing template you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The billing template could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add billing template based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1billingTemplates~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BillingTemplate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BillingTemplate"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/billing-templates/createbillingtemplate"}],"panels":[]}]},"httpPath":"/billingTemplates/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/billing-templates/executebatchoperations","routeSlug":"/apis/collect/collect-v1/billing-templates/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1billingTemplates~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1billingTemplates~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1billingTemplates~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/billingTemplates/{tenantId}/batch","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/billingTemplates/{tenantId}/batch","href":"billing-templates/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The billing template could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve billing template based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1billingTemplates~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/billing-templates/executebatchoperations"}],"panels":[]}]},"httpPath":"/billingTemplates/{tenantId}/batch"},{"label":"Returns a billing template from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/billing-templates/deletebillingtemplate","routeSlug":"/apis/collect/collect-v1/billing-templates/deletebillingtemplate","metadata":{"seo":{"title":"Returns a billing template from the system by its ID.","description":"This method will delete a billing template with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteBillingTemplate","name":"Returns a billing template from the system by its ID.","isWebhook":false,"pointer":"/paths/~1billingTemplates~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a billing template from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a billing template with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the billing template to delete.","required":true}],"pointer":"/paths/~1billingTemplates~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/billingTemplates/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/billingTemplates/{tenantId}/{id}","href":"billing-templates/deletebillingtemplate","openApiOperationId":"deleteBillingTemplate","summary":"Returns a billing template from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The billing template was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}},"schemaId":"schema_409","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The billing template could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The billing template could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to delete billing template based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1billingTemplates~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_409","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/billing-templates/deletebillingtemplate"}],"panels":[]}]},"httpPath":"/billingTemplates/{tenantId}/{id}"},{"label":"Returns a billing template from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/billing-templates/getbillingtemplate","routeSlug":"/apis/collect/collect-v1/billing-templates/getbillingtemplate","metadata":{"seo":{"title":"Returns a billing template from the system by its ID.","description":"This method will look up a billing template by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getBillingTemplate","name":"Returns a billing template from the system by its ID.","isWebhook":false,"pointer":"/paths/~1billingTemplates~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a billing template from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a billing template by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the billing template to return.","required":true}],"pointer":"/paths/~1billingTemplates~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_409","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1billingTemplates~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/billingTemplates/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/billingTemplates/{tenantId}/{id}","href":"billing-templates/getbillingtemplate","openApiOperationId":"getBillingTemplate","summary":"Returns a billing template from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The billing template was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BillingTemplate"}},"schemaId":"components/schemas/BillingTemplate","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The billing template could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve billing template based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1billingTemplates~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BillingTemplate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BillingTemplate"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/billing-templates/getbillingtemplate"}],"panels":[]}]},"httpPath":"/billingTemplates/{tenantId}/{id}"},{"label":"Partially updates a billing template with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/billing-templates/patchbillingtemplate","routeSlug":"/apis/collect/collect-v1/billing-templates/patchbillingtemplate","metadata":{"seo":{"title":"Partially updates a billing template with the specified ID.","description":"This method will patch an existing billing template with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchBillingTemplate","name":"Partially updates a billing template with the specified ID.","isWebhook":false,"pointer":"/paths/~1billingTemplates~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a billing template with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing billing template with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the billing template to patch.","required":true}],"pointer":"/paths/~1billingTemplates~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"schemaId":"schema_412","pointer":"/paths/~1billingTemplates~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/billingTemplates/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_412"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/billingTemplates/{tenantId}/{id}","href":"billing-templates/patchbillingtemplate","openApiOperationId":"patchBillingTemplate","summary":"Partially updates a billing template with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"schema_412","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The billing template was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BillingTemplate"}},"schemaId":"components/schemas/BillingTemplate","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The billing template could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The billing template could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve billing template based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1billingTemplates~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BillingTemplate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BillingTemplate"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/billing-templates/patchbillingtemplate"}],"panels":[]}]},"httpPath":"/billingTemplates/{tenantId}/{id}"},{"label":"Updates a billing template with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/billing-templates/updatebillingtemplate","routeSlug":"/apis/collect/collect-v1/billing-templates/updatebillingtemplate","metadata":{"seo":{"title":"Updates a billing template with the specified ID.","description":"This method will update an existing billing template with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateBillingTemplate","name":"Updates a billing template with the specified ID.","isWebhook":false,"pointer":"/paths/~1billingTemplates~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a billing template with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing billing template with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the billing template to update.","required":true}],"pointer":"/paths/~1billingTemplates~1{tenantId}~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/BillingTemplate"}},"schemaId":"components/schemas/BillingTemplate","pointer":"/paths/~1billingTemplates~1{tenantId}~1{id}/put/requestBody","description":"The updated billing template that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/billingTemplates/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BillingTemplate"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/billingTemplates/{tenantId}/{id}","href":"billing-templates/updatebillingtemplate","openApiOperationId":"updateBillingTemplate","summary":"Updates a billing template with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BillingTemplate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BillingTemplate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The billing template was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BillingTemplate"}},"schemaId":"components/schemas/BillingTemplate","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The billing template supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The billing template could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The billing template could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve billing template based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1billingTemplates~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BillingTemplate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BillingTemplate"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/billing-templates/updatebillingtemplate"}],"panels":[]}]},"httpPath":"/billingTemplates/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Billing Templates"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Billing Templates","showPageActions":true},{"nodeType":"markdoc","content":"Billing Templates"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/billingTemplates/{tenantId}","summary":"Gets all of the billing templates in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/billing-templates/listbillingtemplates","deprecated":false},{"title":"/billingTemplates/{tenantId}","summary":"Creates a new billing template record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/billing-templates/createbillingtemplate","deprecated":false},{"title":"/billingTemplates/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/billing-templates/executebatchoperations","deprecated":false},{"title":"/billingTemplates/{tenantId}/{id}","summary":"Returns a billing template from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/billing-templates/deletebillingtemplate","deprecated":false},{"title":"/billingTemplates/{tenantId}/{id}","summary":"Returns a billing template from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/billing-templates/getbillingtemplate","deprecated":false},{"title":"/billingTemplates/{tenantId}/{id}","summary":"Partially updates a billing template with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/billing-templates/patchbillingtemplate","deprecated":false},{"title":"/billingTemplates/{tenantId}/{id}","summary":"Updates a billing template with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/billing-templates/updatebillingtemplate","deprecated":false}]}]}]}]}},{"type":"group","label":"Business Units","link":"/apis/collect/collect-v1/business-units","routeSlug":"/apis/collect/collect-v1/business-units","items":[{"label":"Gets all of the business units in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/business-units/listbusinessunits","routeSlug":"/apis/collect/collect-v1/business-units/listbusinessunits","metadata":{"seo":{"title":"Gets all of the business units in the system.","description":"This method will scan all business units and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listBusinessUnits","name":"Gets all of the business units in the system.","isWebhook":false,"pointer":"/paths/~1businessUnits~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the business units in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all business units and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1businessUnits~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1businessUnits~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/businessUnits/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/businessUnits/{tenantId}","href":"business-units/listbusinessunits","openApiOperationId":"listBusinessUnits","summary":"Gets all of the business units in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The business unitswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_420"}},"schemaId":"schema_420","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1businessUnits~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_420","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_420"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/business-units/listbusinessunits"}],"panels":[]}]},"httpPath":"/businessUnits/{tenantId}"},{"label":"Creates a new business unit record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/business-units/createbusinessunit","routeSlug":"/apis/collect/collect-v1/business-units/createbusinessunit","metadata":{"seo":{"title":"Creates a new business unit record that does not already exist.","description":"This method will auto-generate an ID and create a new business unit. If an ID is specified for the business unit, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createBusinessUnit","name":"Creates a new business unit record that does not already exist.","isWebhook":false,"pointer":"/paths/~1businessUnits~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new business unit record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new business unit. If an ID is specified for the business unit, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1businessUnits~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BusinessUnit"}},"schemaId":"components/schemas/BusinessUnit","pointer":"/paths/~1businessUnits~1{tenantId}/post/requestBody","description":"The business unit that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/businessUnits/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BusinessUnit"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/businessUnits/{tenantId}","href":"business-units/createbusinessunit","openApiOperationId":"createBusinessUnit","summary":"Creates a new business unit record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BusinessUnit","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BusinessUnit"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The business unit was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BusinessUnit"}},"schemaId":"components/schemas/BusinessUnit","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The business unit you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The business unit could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add business unit based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1businessUnits~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BusinessUnit","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BusinessUnit"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/business-units/createbusinessunit"}],"panels":[]}]},"httpPath":"/businessUnits/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/business-units/executebatchoperations","routeSlug":"/apis/collect/collect-v1/business-units/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1businessUnits~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1businessUnits~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1businessUnits~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/businessUnits/{tenantId}/batch","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/businessUnits/{tenantId}/batch","href":"business-units/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The business unit could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve business unit based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1businessUnits~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/business-units/executebatchoperations"}],"panels":[]}]},"httpPath":"/businessUnits/{tenantId}/batch"},{"label":"Returns a business unit from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/business-units/deletebusinessunit","routeSlug":"/apis/collect/collect-v1/business-units/deletebusinessunit","metadata":{"seo":{"title":"Returns a business unit from the system by its ID.","description":"This method will delete a business unit with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteBusinessUnit","name":"Returns a business unit from the system by its ID.","isWebhook":false,"pointer":"/paths/~1businessUnits~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a business unit from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a business unit with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the business unit to delete.","required":true}],"pointer":"/paths/~1businessUnits~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/businessUnits/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/businessUnits/{tenantId}/{id}","href":"business-units/deletebusinessunit","openApiOperationId":"deleteBusinessUnit","summary":"Returns a business unit from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The business unit was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}},"schemaId":"schema_409","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The business unit could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The business unit could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to delete business unit based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1businessUnits~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_409","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/business-units/deletebusinessunit"}],"panels":[]}]},"httpPath":"/businessUnits/{tenantId}/{id}"},{"label":"Returns a business unit from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/business-units/getbusinessunit","routeSlug":"/apis/collect/collect-v1/business-units/getbusinessunit","metadata":{"seo":{"title":"Returns a business unit from the system by its ID.","description":"This method will look up a business unit by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getBusinessUnit","name":"Returns a business unit from the system by its ID.","isWebhook":false,"pointer":"/paths/~1businessUnits~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a business unit from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a business unit by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the business unit to return.","required":true}],"pointer":"/paths/~1businessUnits~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_409","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1businessUnits~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/businessUnits/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/businessUnits/{tenantId}/{id}","href":"business-units/getbusinessunit","openApiOperationId":"getBusinessUnit","summary":"Returns a business unit from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The business unit was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BusinessUnit"}},"schemaId":"components/schemas/BusinessUnit","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The business unit could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve business unit based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1businessUnits~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BusinessUnit","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BusinessUnit"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/business-units/getbusinessunit"}],"panels":[]}]},"httpPath":"/businessUnits/{tenantId}/{id}"},{"label":"Partially updates a business unit with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/business-units/patchbusinessunit","routeSlug":"/apis/collect/collect-v1/business-units/patchbusinessunit","metadata":{"seo":{"title":"Partially updates a business unit with the specified ID.","description":"This method will patch an existing business unit with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchBusinessUnit","name":"Partially updates a business unit with the specified ID.","isWebhook":false,"pointer":"/paths/~1businessUnits~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a business unit with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing business unit with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the business unit to patch.","required":true}],"pointer":"/paths/~1businessUnits~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"schemaId":"schema_412","pointer":"/paths/~1businessUnits~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/businessUnits/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_412"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/businessUnits/{tenantId}/{id}","href":"business-units/patchbusinessunit","openApiOperationId":"patchBusinessUnit","summary":"Partially updates a business unit with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"schema_412","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The business unit was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BusinessUnit"}},"schemaId":"components/schemas/BusinessUnit","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The business unit could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The business unit could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve business unit based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1businessUnits~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BusinessUnit","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BusinessUnit"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/business-units/patchbusinessunit"}],"panels":[]}]},"httpPath":"/businessUnits/{tenantId}/{id}"},{"label":"Updates a business unit with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/business-units/updatebusinessunit","routeSlug":"/apis/collect/collect-v1/business-units/updatebusinessunit","metadata":{"seo":{"title":"Updates a business unit with the specified ID.","description":"This method will update an existing business unit with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateBusinessUnit","name":"Updates a business unit with the specified ID.","isWebhook":false,"pointer":"/paths/~1businessUnits~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a business unit with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing business unit with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the business unit to update.","required":true}],"pointer":"/paths/~1businessUnits~1{tenantId}~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/BusinessUnit"}},"schemaId":"components/schemas/BusinessUnit","pointer":"/paths/~1businessUnits~1{tenantId}~1{id}/put/requestBody","description":"The updated business unit that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/businessUnits/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BusinessUnit"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/businessUnits/{tenantId}/{id}","href":"business-units/updatebusinessunit","openApiOperationId":"updateBusinessUnit","summary":"Updates a business unit with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BusinessUnit","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BusinessUnit"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The business unit was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BusinessUnit"}},"schemaId":"components/schemas/BusinessUnit","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The business unit supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The business unit could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The business unit could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve business unit based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1businessUnits~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BusinessUnit","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BusinessUnit"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/business-units/updatebusinessunit"}],"panels":[]}]},"httpPath":"/businessUnits/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Business Units"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Business Units","showPageActions":true},{"nodeType":"markdoc","content":"Business Units"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/businessUnits/{tenantId}","summary":"Gets all of the business units in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/business-units/listbusinessunits","deprecated":false},{"title":"/businessUnits/{tenantId}","summary":"Creates a new business unit record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/business-units/createbusinessunit","deprecated":false},{"title":"/businessUnits/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/business-units/executebatchoperations","deprecated":false},{"title":"/businessUnits/{tenantId}/{id}","summary":"Returns a business unit from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/business-units/deletebusinessunit","deprecated":false},{"title":"/businessUnits/{tenantId}/{id}","summary":"Returns a business unit from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/business-units/getbusinessunit","deprecated":false},{"title":"/businessUnits/{tenantId}/{id}","summary":"Partially updates a business unit with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/business-units/patchbusinessunit","deprecated":false},{"title":"/businessUnits/{tenantId}/{id}","summary":"Updates a business unit with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/business-units/updatebusinessunit","deprecated":false}]}]}]}]}},{"type":"group","label":"Check Request Processes","link":"/apis/collect/collect-v1/check-request-processes","routeSlug":"/apis/collect/collect-v1/check-request-processes","items":[{"label":"Gets all of the check request processes in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/check-request-processes/listcheckrequestprocesses","routeSlug":"/apis/collect/collect-v1/check-request-processes/listcheckrequestprocesses","metadata":{"seo":{"title":"Gets all of the check request processes in the system.","description":"This method will scan all check request processes and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCheckRequestProcesses","name":"Gets all of the check request processes in the system.","isWebhook":false,"pointer":"/paths/~1checkRequestProcesses~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the check request processes in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all check request processes and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1checkRequestProcesses~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1checkRequestProcesses~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/checkRequestProcesses/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/checkRequestProcesses/{tenantId}","href":"check-request-processes/listcheckrequestprocesses","openApiOperationId":"listCheckRequestProcesses","summary":"Gets all of the check request processes in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The check request processeswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_421"}},"schemaId":"schema_421","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1checkRequestProcesses~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_421","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_421"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/check-request-processes/listcheckrequestprocesses"}],"panels":[]}]},"httpPath":"/checkRequestProcesses/{tenantId}"},{"label":"Creates a new check request process record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/check-request-processes/createcheckrequestprocess","routeSlug":"/apis/collect/collect-v1/check-request-processes/createcheckrequestprocess","metadata":{"seo":{"title":"Creates a new check request process record that does not already exist.","description":"This method will auto-generate an ID and create a new check request process. If an ID is specified for the check request process, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createCheckRequestProcess","name":"Creates a new check request process record that does not already exist.","isWebhook":false,"pointer":"/paths/~1checkRequestProcesses~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new check request process record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new check request process. If an ID is specified for the check request process, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1checkRequestProcesses~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CheckRequestProcess"}},"schemaId":"components/schemas/CheckRequestProcess","pointer":"/paths/~1checkRequestProcesses~1{tenantId}/post/requestBody","description":"The check request process that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/checkRequestProcesses/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CheckRequestProcess"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/checkRequestProcesses/{tenantId}","href":"check-request-processes/createcheckrequestprocess","openApiOperationId":"createCheckRequestProcess","summary":"Creates a new check request process record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/CheckRequestProcess","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CheckRequestProcess"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The check request process was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CheckRequestProcess"}},"schemaId":"components/schemas/CheckRequestProcess","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The check request process you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The check request process could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add check request process based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1checkRequestProcesses~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CheckRequestProcess","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CheckRequestProcess"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/check-request-processes/createcheckrequestprocess"}],"panels":[]}]},"httpPath":"/checkRequestProcesses/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/check-request-processes/executebatchoperations","routeSlug":"/apis/collect/collect-v1/check-request-processes/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1checkRequestProcesses~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1checkRequestProcesses~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1checkRequestProcesses~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/checkRequestProcesses/{tenantId}/batch","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/checkRequestProcesses/{tenantId}/batch","href":"check-request-processes/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The check request process could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve check request process based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1checkRequestProcesses~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/check-request-processes/executebatchoperations"}],"panels":[]}]},"httpPath":"/checkRequestProcesses/{tenantId}/batch"},{"label":"Returns a check request process from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/check-request-processes/deletecheckrequestprocess","routeSlug":"/apis/collect/collect-v1/check-request-processes/deletecheckrequestprocess","metadata":{"seo":{"title":"Returns a check request process from the system by its ID.","description":"This method will delete a check request process with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteCheckRequestProcess","name":"Returns a check request process from the system by its ID.","isWebhook":false,"pointer":"/paths/~1checkRequestProcesses~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a check request process from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a check request process with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the check request process to delete.","required":true}],"pointer":"/paths/~1checkRequestProcesses~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/checkRequestProcesses/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/checkRequestProcesses/{tenantId}/{id}","href":"check-request-processes/deletecheckrequestprocess","openApiOperationId":"deleteCheckRequestProcess","summary":"Returns a check request process from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The check request process was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}},"schemaId":"schema_409","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The check request process could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The check request process could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to delete check request process based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1checkRequestProcesses~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_409","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/check-request-processes/deletecheckrequestprocess"}],"panels":[]}]},"httpPath":"/checkRequestProcesses/{tenantId}/{id}"},{"label":"Returns a check request process from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/check-request-processes/getcheckrequestprocess","routeSlug":"/apis/collect/collect-v1/check-request-processes/getcheckrequestprocess","metadata":{"seo":{"title":"Returns a check request process from the system by its ID.","description":"This method will look up a check request process by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCheckRequestProcess","name":"Returns a check request process from the system by its ID.","isWebhook":false,"pointer":"/paths/~1checkRequestProcesses~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a check request process from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a check request process by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the check request process to return.","required":true}],"pointer":"/paths/~1checkRequestProcesses~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_409","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1checkRequestProcesses~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/checkRequestProcesses/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/checkRequestProcesses/{tenantId}/{id}","href":"check-request-processes/getcheckrequestprocess","openApiOperationId":"getCheckRequestProcess","summary":"Returns a check request process from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The check request process was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CheckRequestProcess"}},"schemaId":"components/schemas/CheckRequestProcess","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The check request process could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve check request process based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1checkRequestProcesses~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CheckRequestProcess","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CheckRequestProcess"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/check-request-processes/getcheckrequestprocess"}],"panels":[]}]},"httpPath":"/checkRequestProcesses/{tenantId}/{id}"},{"label":"Partially updates a check request process with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/check-request-processes/patchcheckrequestprocess","routeSlug":"/apis/collect/collect-v1/check-request-processes/patchcheckrequestprocess","metadata":{"seo":{"title":"Partially updates a check request process with the specified ID.","description":"This method will patch an existing check request process with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchCheckRequestProcess","name":"Partially updates a check request process with the specified ID.","isWebhook":false,"pointer":"/paths/~1checkRequestProcesses~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a check request process with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing check request process with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the check request process to patch.","required":true}],"pointer":"/paths/~1checkRequestProcesses~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"schemaId":"schema_412","pointer":"/paths/~1checkRequestProcesses~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/checkRequestProcesses/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_412"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/checkRequestProcesses/{tenantId}/{id}","href":"check-request-processes/patchcheckrequestprocess","openApiOperationId":"patchCheckRequestProcess","summary":"Partially updates a check request process with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"schema_412","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The check request process was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CheckRequestProcess"}},"schemaId":"components/schemas/CheckRequestProcess","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The check request process could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The check request process could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve check request process based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1checkRequestProcesses~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CheckRequestProcess","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CheckRequestProcess"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/check-request-processes/patchcheckrequestprocess"}],"panels":[]}]},"httpPath":"/checkRequestProcesses/{tenantId}/{id}"},{"label":"Updates a check request process with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/check-request-processes/updatecheckrequestprocess","routeSlug":"/apis/collect/collect-v1/check-request-processes/updatecheckrequestprocess","metadata":{"seo":{"title":"Updates a check request process with the specified ID.","description":"This method will update an existing check request process with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateCheckRequestProcess","name":"Updates a check request process with the specified ID.","isWebhook":false,"pointer":"/paths/~1checkRequestProcesses~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a check request process with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing check request process with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the check request process to update.","required":true}],"pointer":"/paths/~1checkRequestProcesses~1{tenantId}~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/CheckRequestProcess"}},"schemaId":"components/schemas/CheckRequestProcess","pointer":"/paths/~1checkRequestProcesses~1{tenantId}~1{id}/put/requestBody","description":"The updated check request process that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/checkRequestProcesses/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CheckRequestProcess"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/checkRequestProcesses/{tenantId}/{id}","href":"check-request-processes/updatecheckrequestprocess","openApiOperationId":"updateCheckRequestProcess","summary":"Updates a check request process with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/CheckRequestProcess","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CheckRequestProcess"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The check request process was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CheckRequestProcess"}},"schemaId":"components/schemas/CheckRequestProcess","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The check request process supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The check request process could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The check request process could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve check request process based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1checkRequestProcesses~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CheckRequestProcess","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CheckRequestProcess"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/check-request-processes/updatecheckrequestprocess"}],"panels":[]}]},"httpPath":"/checkRequestProcesses/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Check Request Processes"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Check Request Processes","showPageActions":true},{"nodeType":"markdoc","content":"Check Request Processes"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/checkRequestProcesses/{tenantId}","summary":"Gets all of the check request processes in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/check-request-processes/listcheckrequestprocesses","deprecated":false},{"title":"/checkRequestProcesses/{tenantId}","summary":"Creates a new check request process record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/check-request-processes/createcheckrequestprocess","deprecated":false},{"title":"/checkRequestProcesses/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/check-request-processes/executebatchoperations","deprecated":false},{"title":"/checkRequestProcesses/{tenantId}/{id}","summary":"Returns a check request process from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/check-request-processes/deletecheckrequestprocess","deprecated":false},{"title":"/checkRequestProcesses/{tenantId}/{id}","summary":"Returns a check request process from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/check-request-processes/getcheckrequestprocess","deprecated":false},{"title":"/checkRequestProcesses/{tenantId}/{id}","summary":"Partially updates a check request process with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/check-request-processes/patchcheckrequestprocess","deprecated":false},{"title":"/checkRequestProcesses/{tenantId}/{id}","summary":"Updates a check request process with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/check-request-processes/updatecheckrequestprocess","deprecated":false}]}]}]}]}},{"type":"group","label":"Check Request Templates","link":"/apis/collect/collect-v1/check-request-templates","routeSlug":"/apis/collect/collect-v1/check-request-templates","items":[{"label":"Gets all of the check request templates in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/check-request-templates/listcheckrequesttemplates","routeSlug":"/apis/collect/collect-v1/check-request-templates/listcheckrequesttemplates","metadata":{"seo":{"title":"Gets all of the check request templates in the system.","description":"This method will scan all check request templates and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCheckRequestTemplates","name":"Gets all of the check request templates in the system.","isWebhook":false,"pointer":"/paths/~1checkRequestTemplates~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the check request templates in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all check request templates and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1checkRequestTemplates~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1checkRequestTemplates~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/checkRequestTemplates/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/checkRequestTemplates/{tenantId}","href":"check-request-templates/listcheckrequesttemplates","openApiOperationId":"listCheckRequestTemplates","summary":"Gets all of the check request templates in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The check request templateswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_422"}},"schemaId":"schema_422","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1checkRequestTemplates~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_422","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_422"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/check-request-templates/listcheckrequesttemplates"}],"panels":[]}]},"httpPath":"/checkRequestTemplates/{tenantId}"},{"label":"Creates a new check request template record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/check-request-templates/createcheckrequesttemplate","routeSlug":"/apis/collect/collect-v1/check-request-templates/createcheckrequesttemplate","metadata":{"seo":{"title":"Creates a new check request template record that does not already exist.","description":"This method will auto-generate an ID and create a new check request template. If an ID is specified for the check request template, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createCheckRequestTemplate","name":"Creates a new check request template record that does not already exist.","isWebhook":false,"pointer":"/paths/~1checkRequestTemplates~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new check request template record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new check request template. If an ID is specified for the check request template, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1checkRequestTemplates~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CheckRequestTemplate"}},"schemaId":"components/schemas/CheckRequestTemplate","pointer":"/paths/~1checkRequestTemplates~1{tenantId}/post/requestBody","description":"The check request template that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/checkRequestTemplates/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CheckRequestTemplate"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/checkRequestTemplates/{tenantId}","href":"check-request-templates/createcheckrequesttemplate","openApiOperationId":"createCheckRequestTemplate","summary":"Creates a new check request template record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/CheckRequestTemplate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CheckRequestTemplate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The check request template was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CheckRequestTemplate"}},"schemaId":"components/schemas/CheckRequestTemplate","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The check request template you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The check request template could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add check request template based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1checkRequestTemplates~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CheckRequestTemplate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CheckRequestTemplate"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/check-request-templates/createcheckrequesttemplate"}],"panels":[]}]},"httpPath":"/checkRequestTemplates/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/check-request-templates/executebatchoperations","routeSlug":"/apis/collect/collect-v1/check-request-templates/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1checkRequestTemplates~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1checkRequestTemplates~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1checkRequestTemplates~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/checkRequestTemplates/{tenantId}/batch","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/checkRequestTemplates/{tenantId}/batch","href":"check-request-templates/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The check request template could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve check request template based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1checkRequestTemplates~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/check-request-templates/executebatchoperations"}],"panels":[]}]},"httpPath":"/checkRequestTemplates/{tenantId}/batch"},{"label":"Returns a check request template from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/check-request-templates/deletecheckrequesttemplate","routeSlug":"/apis/collect/collect-v1/check-request-templates/deletecheckrequesttemplate","metadata":{"seo":{"title":"Returns a check request template from the system by its ID.","description":"This method will delete a check request template with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteCheckRequestTemplate","name":"Returns a check request template from the system by its ID.","isWebhook":false,"pointer":"/paths/~1checkRequestTemplates~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a check request template from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a check request template with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the check request template to delete.","required":true}],"pointer":"/paths/~1checkRequestTemplates~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/checkRequestTemplates/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/checkRequestTemplates/{tenantId}/{id}","href":"check-request-templates/deletecheckrequesttemplate","openApiOperationId":"deleteCheckRequestTemplate","summary":"Returns a check request template from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The check request template was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}},"schemaId":"schema_409","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The check request template could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The check request template could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to delete check request template based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1checkRequestTemplates~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_409","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/check-request-templates/deletecheckrequesttemplate"}],"panels":[]}]},"httpPath":"/checkRequestTemplates/{tenantId}/{id}"},{"label":"Returns a check request template from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/check-request-templates/getcheckrequesttemplate","routeSlug":"/apis/collect/collect-v1/check-request-templates/getcheckrequesttemplate","metadata":{"seo":{"title":"Returns a check request template from the system by its ID.","description":"This method will look up a check request template by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCheckRequestTemplate","name":"Returns a check request template from the system by its ID.","isWebhook":false,"pointer":"/paths/~1checkRequestTemplates~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a check request template from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a check request template by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the check request template to return.","required":true}],"pointer":"/paths/~1checkRequestTemplates~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_409","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1checkRequestTemplates~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/checkRequestTemplates/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/checkRequestTemplates/{tenantId}/{id}","href":"check-request-templates/getcheckrequesttemplate","openApiOperationId":"getCheckRequestTemplate","summary":"Returns a check request template from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The check request template was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CheckRequestTemplate"}},"schemaId":"components/schemas/CheckRequestTemplate","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The check request template could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve check request template based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1checkRequestTemplates~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CheckRequestTemplate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CheckRequestTemplate"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/check-request-templates/getcheckrequesttemplate"}],"panels":[]}]},"httpPath":"/checkRequestTemplates/{tenantId}/{id}"},{"label":"Partially updates a check request template with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/check-request-templates/patchcheckrequesttemplate","routeSlug":"/apis/collect/collect-v1/check-request-templates/patchcheckrequesttemplate","metadata":{"seo":{"title":"Partially updates a check request template with the specified ID.","description":"This method will patch an existing check request template with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchCheckRequestTemplate","name":"Partially updates a check request template with the specified ID.","isWebhook":false,"pointer":"/paths/~1checkRequestTemplates~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a check request template with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing check request template with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the check request template to patch.","required":true}],"pointer":"/paths/~1checkRequestTemplates~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"schemaId":"schema_412","pointer":"/paths/~1checkRequestTemplates~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/checkRequestTemplates/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_412"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/checkRequestTemplates/{tenantId}/{id}","href":"check-request-templates/patchcheckrequesttemplate","openApiOperationId":"patchCheckRequestTemplate","summary":"Partially updates a check request template with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"schema_412","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The check request template was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CheckRequestTemplate"}},"schemaId":"components/schemas/CheckRequestTemplate","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The check request template could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The check request template could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve check request template based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1checkRequestTemplates~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CheckRequestTemplate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CheckRequestTemplate"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/check-request-templates/patchcheckrequesttemplate"}],"panels":[]}]},"httpPath":"/checkRequestTemplates/{tenantId}/{id}"},{"label":"Updates a check request template with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/check-request-templates/updatecheckrequesttemplate","routeSlug":"/apis/collect/collect-v1/check-request-templates/updatecheckrequesttemplate","metadata":{"seo":{"title":"Updates a check request template with the specified ID.","description":"This method will update an existing check request template with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateCheckRequestTemplate","name":"Updates a check request template with the specified ID.","isWebhook":false,"pointer":"/paths/~1checkRequestTemplates~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a check request template with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing check request template with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the check request template to update.","required":true}],"pointer":"/paths/~1checkRequestTemplates~1{tenantId}~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/CheckRequestTemplate"}},"schemaId":"components/schemas/CheckRequestTemplate","pointer":"/paths/~1checkRequestTemplates~1{tenantId}~1{id}/put/requestBody","description":"The updated check request template that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/checkRequestTemplates/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CheckRequestTemplate"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/checkRequestTemplates/{tenantId}/{id}","href":"check-request-templates/updatecheckrequesttemplate","openApiOperationId":"updateCheckRequestTemplate","summary":"Updates a check request template with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/CheckRequestTemplate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CheckRequestTemplate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The check request template was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CheckRequestTemplate"}},"schemaId":"components/schemas/CheckRequestTemplate","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The check request template supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The check request template could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The check request template could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve check request template based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1checkRequestTemplates~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CheckRequestTemplate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CheckRequestTemplate"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/check-request-templates/updatecheckrequesttemplate"}],"panels":[]}]},"httpPath":"/checkRequestTemplates/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Check Request Templates"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Check Request Templates","showPageActions":true},{"nodeType":"markdoc","content":"Check Request Templates"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/checkRequestTemplates/{tenantId}","summary":"Gets all of the check request templates in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/check-request-templates/listcheckrequesttemplates","deprecated":false},{"title":"/checkRequestTemplates/{tenantId}","summary":"Creates a new check request template record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/check-request-templates/createcheckrequesttemplate","deprecated":false},{"title":"/checkRequestTemplates/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/check-request-templates/executebatchoperations","deprecated":false},{"title":"/checkRequestTemplates/{tenantId}/{id}","summary":"Returns a check request template from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/check-request-templates/deletecheckrequesttemplate","deprecated":false},{"title":"/checkRequestTemplates/{tenantId}/{id}","summary":"Returns a check request template from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/check-request-templates/getcheckrequesttemplate","deprecated":false},{"title":"/checkRequestTemplates/{tenantId}/{id}","summary":"Partially updates a check request template with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/check-request-templates/patchcheckrequesttemplate","deprecated":false},{"title":"/checkRequestTemplates/{tenantId}/{id}","summary":"Updates a check request template with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/check-request-templates/updatecheckrequesttemplate","deprecated":false}]}]}]}]}},{"type":"group","label":"Check Requests","link":"/apis/collect/collect-v1/check-requests","routeSlug":"/apis/collect/collect-v1/check-requests","items":[{"label":"Gets all of the check requests in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/check-requests/listcheckrequests","routeSlug":"/apis/collect/collect-v1/check-requests/listcheckrequests","metadata":{"seo":{"title":"Gets all of the check requests in the system.","description":"This method will scan all check requests and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCheckRequests","name":"Gets all of the check requests in the system.","isWebhook":false,"pointer":"/paths/~1checkRequests~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the check requests in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all check requests and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1checkRequests~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1checkRequests~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/checkRequests/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/checkRequests/{tenantId}","href":"check-requests/listcheckrequests","openApiOperationId":"listCheckRequests","summary":"Gets all of the check requests in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The check requestswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_423"}},"schemaId":"schema_423","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1checkRequests~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_423","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_423"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/check-requests/listcheckrequests"}],"panels":[]}]},"httpPath":"/checkRequests/{tenantId}"},{"label":"Creates a new check request record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/check-requests/createcheckrequest","routeSlug":"/apis/collect/collect-v1/check-requests/createcheckrequest","metadata":{"seo":{"title":"Creates a new check request record that does not already exist.","description":"This method will auto-generate an ID and create a new check request. If an ID is specified for the check request, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createCheckRequest","name":"Creates a new check request record that does not already exist.","isWebhook":false,"pointer":"/paths/~1checkRequests~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new check request record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new check request. If an ID is specified for the check request, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1checkRequests~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CheckRequest"}},"schemaId":"components/schemas/CheckRequest","pointer":"/paths/~1checkRequests~1{tenantId}/post/requestBody","description":"The check request that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/checkRequests/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CheckRequest"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/checkRequests/{tenantId}","href":"check-requests/createcheckrequest","openApiOperationId":"createCheckRequest","summary":"Creates a new check request record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/CheckRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CheckRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The check request was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CheckRequest"}},"schemaId":"components/schemas/CheckRequest","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The check request you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The check request could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add check request based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1checkRequests~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CheckRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CheckRequest"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/check-requests/createcheckrequest"}],"panels":[]}]},"httpPath":"/checkRequests/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/check-requests/executebatchoperations","routeSlug":"/apis/collect/collect-v1/check-requests/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1checkRequests~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1checkRequests~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1checkRequests~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/checkRequests/{tenantId}/batch","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/checkRequests/{tenantId}/batch","href":"check-requests/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The check request could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve check request based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1checkRequests~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/check-requests/executebatchoperations"}],"panels":[]}]},"httpPath":"/checkRequests/{tenantId}/batch"},{"label":"Process the check request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/check-requests/processcheckrequest","routeSlug":"/apis/collect/collect-v1/check-requests/processcheckrequest","metadata":{"seo":{"title":"Process the check request","description":"Process the check request"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"processCheckRequest","name":"Process the check request","isWebhook":false,"pointer":"/paths/~1checkRequests~1{tenantId}~1process/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Process the check request","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed","required":true}],"pointer":"/paths/~1checkRequests~1{tenantId}~1process/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CheckRequest"}},"schemaId":"components/schemas/CheckRequest","pointer":"/paths/~1checkRequests~1{tenantId}~1process/post/requestBody","description":"The body for the process request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/checkRequests/{tenantId}/process","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CheckRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/checkRequests/{tenantId}/process","href":"check-requests/processcheckrequest","openApiOperationId":"processCheckRequest","summary":"Process the check request"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/CheckRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CheckRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1checkRequests~1{tenantId}~1process/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/check-requests/processcheckrequest"}],"panels":[]}]},"httpPath":"/checkRequests/{tenantId}/process"},{"label":"Render the check request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/check-requests/rendercheckrequest","routeSlug":"/apis/collect/collect-v1/check-requests/rendercheckrequest","metadata":{"seo":{"title":"Render the check request","description":"Render the check request"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"renderCheckRequest","name":"Render the check request","isWebhook":false,"pointer":"/paths/~1checkRequests~1{tenantId}~1render/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Render the check request","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed","required":true}],"pointer":"/paths/~1checkRequests~1{tenantId}~1render/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CheckRequest"}},"schemaId":"components/schemas/CheckRequest","pointer":"/paths/~1checkRequests~1{tenantId}~1render/post/requestBody","description":"The the body for the render request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/checkRequests/{tenantId}/render","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CheckRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/checkRequests/{tenantId}/render","href":"check-requests/rendercheckrequest","openApiOperationId":"renderCheckRequest","summary":"Render the check request"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/CheckRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CheckRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1checkRequests~1{tenantId}~1render/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/check-requests/rendercheckrequest"}],"panels":[]}]},"httpPath":"/checkRequests/{tenantId}/render"},{"label":"Searches for check requests using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/check-requests/searchforcheckrequests","routeSlug":"/apis/collect/collect-v1/check-requests/searchforcheckrequests","metadata":{"seo":{"title":"Searches for check requests using predefined parameters","description":"Searches for check requests using predefined parameters"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchForCheckRequests","name":"Searches for check requests using predefined parameters","isWebhook":false,"pointer":"/paths/~1checkRequests~1{tenantId}~1search/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Searches for check requests using predefined parameters","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Searches for check requests using predefined parameters"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1checkRequests~1{tenantId}~1search/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"The start key for the search, for paging support"},{"name":"fieldsToReturn","in":"query","schemaId":"schema_409","description":"  The fields that you want to retrieve; if omitted, the entire object is returned"}],"pointer":"/paths/~1checkRequests~1{tenantId}~1search/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CheckRequestSearchParameters"}},"schemaId":"components/schemas/CheckRequestSearchParameters","pointer":"/paths/~1checkRequests~1{tenantId}~1search/post/requestBody","description":"The check request that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/checkRequests/{tenantId}/search","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"},{"name":"fieldsToReturn","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CheckRequestSearchParameters"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/checkRequests/{tenantId}/search","href":"check-requests/searchforcheckrequests","openApiOperationId":"searchForCheckRequests","summary":"Searches for check requests using predefined parameters"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/CheckRequestSearchParameters","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CheckRequestSearchParameters"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The check request search was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedCheckRequestSearchResults"}},"schemaId":"components/schemas/PagedCheckRequestSearchResults","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The check request you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The check request could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add check request based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1checkRequests~1{tenantId}~1search/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PagedCheckRequestSearchResults","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedCheckRequestSearchResults"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/check-requests/searchforcheckrequests"}],"panels":[]}]},"httpPath":"/checkRequests/{tenantId}/search"},{"label":"Returns a check request from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/check-requests/deletecheckrequest","routeSlug":"/apis/collect/collect-v1/check-requests/deletecheckrequest","metadata":{"seo":{"title":"Returns a check request from the system by its ID.","description":"This method will delete a check request with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteCheckRequest","name":"Returns a check request from the system by its ID.","isWebhook":false,"pointer":"/paths/~1checkRequests~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a check request from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a check request with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the check request to delete.","required":true}],"pointer":"/paths/~1checkRequests~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/checkRequests/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/checkRequests/{tenantId}/{id}","href":"check-requests/deletecheckrequest","openApiOperationId":"deleteCheckRequest","summary":"Returns a check request from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The check request was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}},"schemaId":"schema_409","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The check request could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The check request could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to delete check request based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1checkRequests~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_409","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/check-requests/deletecheckrequest"}],"panels":[]}]},"httpPath":"/checkRequests/{tenantId}/{id}"},{"label":"Returns a check request from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/check-requests/getcheckrequest","routeSlug":"/apis/collect/collect-v1/check-requests/getcheckrequest","metadata":{"seo":{"title":"Returns a check request from the system by its ID.","description":"This method will look up a check request by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCheckRequest","name":"Returns a check request from the system by its ID.","isWebhook":false,"pointer":"/paths/~1checkRequests~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a check request from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a check request by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the check request to return.","required":true}],"pointer":"/paths/~1checkRequests~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_409","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1checkRequests~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/checkRequests/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/checkRequests/{tenantId}/{id}","href":"check-requests/getcheckrequest","openApiOperationId":"getCheckRequest","summary":"Returns a check request from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The check request was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CheckRequest"}},"schemaId":"components/schemas/CheckRequest","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The check request could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve check request based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1checkRequests~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CheckRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CheckRequest"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/check-requests/getcheckrequest"}],"panels":[]}]},"httpPath":"/checkRequests/{tenantId}/{id}"},{"label":"Partially updates a check request with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/check-requests/patchcheckrequest","routeSlug":"/apis/collect/collect-v1/check-requests/patchcheckrequest","metadata":{"seo":{"title":"Partially updates a check request with the specified ID.","description":"This method will patch an existing check request with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchCheckRequest","name":"Partially updates a check request with the specified ID.","isWebhook":false,"pointer":"/paths/~1checkRequests~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a check request with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing check request with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the check request to patch.","required":true}],"pointer":"/paths/~1checkRequests~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"schemaId":"schema_412","pointer":"/paths/~1checkRequests~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/checkRequests/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_412"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/checkRequests/{tenantId}/{id}","href":"check-requests/patchcheckrequest","openApiOperationId":"patchCheckRequest","summary":"Partially updates a check request with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"schema_412","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The check request was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CheckRequest"}},"schemaId":"components/schemas/CheckRequest","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The check request could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The check request could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve check request based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1checkRequests~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CheckRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CheckRequest"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/check-requests/patchcheckrequest"}],"panels":[]}]},"httpPath":"/checkRequests/{tenantId}/{id}"},{"label":"Updates a check request with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/check-requests/updatecheckrequest","routeSlug":"/apis/collect/collect-v1/check-requests/updatecheckrequest","metadata":{"seo":{"title":"Updates a check request with the specified ID.","description":"This method will update an existing check request with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateCheckRequest","name":"Updates a check request with the specified ID.","isWebhook":false,"pointer":"/paths/~1checkRequests~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a check request with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing check request with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the check request to update.","required":true}],"pointer":"/paths/~1checkRequests~1{tenantId}~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/CheckRequest"}},"schemaId":"components/schemas/CheckRequest","pointer":"/paths/~1checkRequests~1{tenantId}~1{id}/put/requestBody","description":"The updated check request that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/checkRequests/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CheckRequest"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/checkRequests/{tenantId}/{id}","href":"check-requests/updatecheckrequest","openApiOperationId":"updateCheckRequest","summary":"Updates a check request with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/CheckRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CheckRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The check request was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CheckRequest"}},"schemaId":"components/schemas/CheckRequest","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The check request supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The check request could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The check request could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve check request based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1checkRequests~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CheckRequest","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CheckRequest"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/check-requests/updatecheckrequest"}],"panels":[]}]},"httpPath":"/checkRequests/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Check Requests"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Check Requests","showPageActions":true},{"nodeType":"markdoc","content":"Check Requests"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/checkRequests/{tenantId}","summary":"Gets all of the check requests in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/check-requests/listcheckrequests","deprecated":false},{"title":"/checkRequests/{tenantId}","summary":"Creates a new check request record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/check-requests/createcheckrequest","deprecated":false},{"title":"/checkRequests/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/check-requests/executebatchoperations","deprecated":false},{"title":"/checkRequests/{tenantId}/process","summary":"Process the check request","prefix":{"name":"post","color":"post"},"badges":[],"link":"/check-requests/processcheckrequest","deprecated":false},{"title":"/checkRequests/{tenantId}/render","summary":"Render the check request","prefix":{"name":"post","color":"post"},"badges":[],"link":"/check-requests/rendercheckrequest","deprecated":false},{"title":"/checkRequests/{tenantId}/search","summary":"Searches for check requests using predefined parameters","prefix":{"name":"post","color":"post"},"badges":[],"link":"/check-requests/searchforcheckrequests","deprecated":false},{"title":"/checkRequests/{tenantId}/{id}","summary":"Returns a check request from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/check-requests/deletecheckrequest","deprecated":false},{"title":"/checkRequests/{tenantId}/{id}","summary":"Returns a check request from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/check-requests/getcheckrequest","deprecated":false},{"title":"/checkRequests/{tenantId}/{id}","summary":"Partially updates a check request with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/check-requests/patchcheckrequest","deprecated":false},{"title":"/checkRequests/{tenantId}/{id}","summary":"Updates a check request with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/check-requests/updatecheckrequest","deprecated":false}]}]}]}]}},{"type":"group","label":"Cogs Entries","link":"/apis/collect/collect-v1/cogs-entries","routeSlug":"/apis/collect/collect-v1/cogs-entries","items":[{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/cogs-entries/executebatchoperations","routeSlug":"/apis/collect/collect-v1/cogs-entries/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1cogsEntries~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1cogsEntries~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1cogsEntries~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/cogsEntries/{tenantId}/batch","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/cogsEntries/{tenantId}/batch","href":"cogs-entries/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The cogs entry could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve cogs entry based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1cogsEntries~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cogs-entries/executebatchoperations"}],"panels":[]}]},"httpPath":"/cogsEntries/{tenantId}/batch"},{"label":"Returns a list of COGS entries in a fiscal period","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/cogs-entries/listcogsentriesbyfiscalperiod","routeSlug":"/apis/collect/collect-v1/cogs-entries/listcogsentriesbyfiscalperiod","metadata":{"seo":{"title":"Returns a list of COGS entries in a fiscal period","description":"Returns a list of COGS entries in a fiscal period"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCogsEntriesByFiscalPeriod","name":"Returns a list of COGS entries in a fiscal period","isWebhook":false,"pointer":"/paths/~1cogsEntries~1{tenantId}~1fiscalperiod~1{fiscal_year_id}~1{fiscal_period}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of COGS entries in a fiscal period","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 COGS entries in a fiscal period"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed","required":true},{"name":"fiscal_year_id","in":"path","schemaId":"schema_409","description":"The fiscal year ID to look up","required":true},{"name":"fiscal_period","in":"path","schemaId":"schema_424","description":"The fiscal period to look up","required":true}],"pointer":"/paths/~1cogsEntries~1{tenantId}~1fiscalperiod~1{fiscal_year_id}~1{fiscal_period}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned"}],"pointer":"/paths/~1cogsEntries~1{tenantId}~1fiscalperiod~1{fiscal_year_id}~1{fiscal_period}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/cogsEntries/{tenantId}/fiscalperiod/{fiscal_year_id}/{fiscal_period}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"fiscal_year_id","in":"path","required":true,"schemaId":"schema_409"},{"name":"fiscal_period","in":"path","required":true,"schemaId":"schema_424"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/cogsEntries/{tenantId}/fiscalperiod/{fiscal_year_id}/{fiscal_period}","href":"cogs-entries/listcogsentriesbyfiscalperiod","openApiOperationId":"listCogsEntriesByFiscalPeriod","summary":"Returns a list of COGS entries in a fiscal period"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The cogs entry was retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_425"}},"schemaId":"schema_425","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The cogs entry could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve cogs entry based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1cogsEntries~1{tenantId}~1fiscalperiod~1{fiscal_year_id}~1{fiscal_period}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_425","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_425"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cogs-entries/listcogsentriesbyfiscalperiod"}],"panels":[]}]},"httpPath":"/cogsEntries/{tenantId}/fiscalperiod/{fiscal_year_id}/{fiscal_period}"},{"label":"Returns a list of COGS entries for a transaction ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/cogs-entries/listcogsentriesforinventorytransaction","routeSlug":"/apis/collect/collect-v1/cogs-entries/listcogsentriesforinventorytransaction","metadata":{"seo":{"title":"Returns a list of COGS entries for a transaction ID","description":"Returns a list of COGS entries for a transaction ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCogsEntriesForInventoryTransaction","name":"Returns a list of COGS entries for a transaction ID","isWebhook":false,"pointer":"/paths/~1cogsEntries~1{tenantId}~1inventoryTransaction~1{inventoryTransactionId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of COGS entries for a transaction ID","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 COGS entries for a transaction ID"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed","required":true},{"name":"inventoryTransactionId","in":"path","schemaId":"schema_409","description":"The inventoryTransactionId to look up","required":true}],"pointer":"/paths/~1cogsEntries~1{tenantId}~1inventoryTransaction~1{inventoryTransactionId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned"}],"pointer":"/paths/~1cogsEntries~1{tenantId}~1inventoryTransaction~1{inventoryTransactionId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/cogsEntries/{tenantId}/inventoryTransaction/{inventoryTransactionId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"inventoryTransactionId","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/cogsEntries/{tenantId}/inventoryTransaction/{inventoryTransactionId}","href":"cogs-entries/listcogsentriesforinventorytransaction","openApiOperationId":"listCogsEntriesForInventoryTransaction","summary":"Returns a list of COGS entries for a transaction ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The cogs entry was retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_425"}},"schemaId":"schema_425","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The cogs entry could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve cogs entry based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1cogsEntries~1{tenantId}~1inventoryTransaction~1{inventoryTransactionId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_425","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_425"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cogs-entries/listcogsentriesforinventorytransaction"}],"panels":[]}]},"httpPath":"/cogsEntries/{tenantId}/inventoryTransaction/{inventoryTransactionId}"},{"label":"Returns a list of COGS entries for an order id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/cogs-entries/listcogsentriesfororder","routeSlug":"/apis/collect/collect-v1/cogs-entries/listcogsentriesfororder","metadata":{"seo":{"title":"Returns a list of COGS entries for an order id","description":"Returns a list of COGS entries for an order id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCogsEntriesForOrder","name":"Returns a list of COGS entries for an order id","isWebhook":false,"pointer":"/paths/~1cogsEntries~1{tenantId}~1order~1{orderId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of COGS entries for an order id","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 COGS entries for an order id"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed","required":true},{"name":"orderId","in":"path","schemaId":"schema_409","description":"The order ID to look up","required":true}],"pointer":"/paths/~1cogsEntries~1{tenantId}~1order~1{orderId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned"}],"pointer":"/paths/~1cogsEntries~1{tenantId}~1order~1{orderId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/cogsEntries/{tenantId}/order/{orderId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"orderId","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/cogsEntries/{tenantId}/order/{orderId}","href":"cogs-entries/listcogsentriesfororder","openApiOperationId":"listCogsEntriesForOrder","summary":"Returns a list of COGS entries for an order id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The cogs entry was retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_425"}},"schemaId":"schema_425","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The cogs entry could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve cogs entry based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1cogsEntries~1{tenantId}~1order~1{orderId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_425","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_425"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cogs-entries/listcogsentriesfororder"}],"panels":[]}]},"httpPath":"/cogsEntries/{tenantId}/order/{orderId}"},{"label":"Returns a cogs entry from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/cogs-entries/deletecogsentry","routeSlug":"/apis/collect/collect-v1/cogs-entries/deletecogsentry","metadata":{"seo":{"title":"Returns a cogs entry from the system by its ID.","description":"This method will delete a cogs entry with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteCogsEntry","name":"Returns a cogs entry from the system by its ID.","isWebhook":false,"pointer":"/paths/~1cogsEntries~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a cogs entry from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a cogs entry with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the cogs entry to delete.","required":true}],"pointer":"/paths/~1cogsEntries~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/cogsEntries/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/cogsEntries/{tenantId}/{id}","href":"cogs-entries/deletecogsentry","openApiOperationId":"deleteCogsEntry","summary":"Returns a cogs entry from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The cogs entry was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}},"schemaId":"schema_409","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The cogs entry could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The cogs entry could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to delete cogs entry based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1cogsEntries~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_409","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cogs-entries/deletecogsentry"}],"panels":[]}]},"httpPath":"/cogsEntries/{tenantId}/{id}"},{"label":"Returns a cogs entry from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/cogs-entries/getcogsentry","routeSlug":"/apis/collect/collect-v1/cogs-entries/getcogsentry","metadata":{"seo":{"title":"Returns a cogs entry from the system by its ID.","description":"This method will look up a cogs entry by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCogsEntry","name":"Returns a cogs entry from the system by its ID.","isWebhook":false,"pointer":"/paths/~1cogsEntries~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a cogs entry from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a cogs entry by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the cogs entry to return.","required":true}],"pointer":"/paths/~1cogsEntries~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_409","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1cogsEntries~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/cogsEntries/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/cogsEntries/{tenantId}/{id}","href":"cogs-entries/getcogsentry","openApiOperationId":"getCogsEntry","summary":"Returns a cogs entry from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The cogs entry was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CogsEntry"}},"schemaId":"components/schemas/CogsEntry","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The cogs entry could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve cogs entry based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1cogsEntries~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CogsEntry","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CogsEntry"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cogs-entries/getcogsentry"}],"panels":[]}]},"httpPath":"/cogsEntries/{tenantId}/{id}"},{"label":"Partially updates a cogs entry with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/cogs-entries/patchcogsentry","routeSlug":"/apis/collect/collect-v1/cogs-entries/patchcogsentry","metadata":{"seo":{"title":"Partially updates a cogs entry with the specified ID.","description":"This method will patch an existing cogs entry with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchCogsEntry","name":"Partially updates a cogs entry with the specified ID.","isWebhook":false,"pointer":"/paths/~1cogsEntries~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a cogs entry with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing cogs entry with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the cogs entry to patch.","required":true}],"pointer":"/paths/~1cogsEntries~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"schemaId":"schema_412","pointer":"/paths/~1cogsEntries~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/cogsEntries/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_412"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/cogsEntries/{tenantId}/{id}","href":"cogs-entries/patchcogsentry","openApiOperationId":"patchCogsEntry","summary":"Partially updates a cogs entry with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"schema_412","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The cogs entry was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CogsEntry"}},"schemaId":"components/schemas/CogsEntry","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The cogs entry could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The cogs entry could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve cogs entry based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1cogsEntries~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CogsEntry","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CogsEntry"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cogs-entries/patchcogsentry"}],"panels":[]}]},"httpPath":"/cogsEntries/{tenantId}/{id}"},{"label":"Updates a cogs entry with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/cogs-entries/updatecogsentry","routeSlug":"/apis/collect/collect-v1/cogs-entries/updatecogsentry","metadata":{"seo":{"title":"Updates a cogs entry with the specified ID.","description":"This method will update an existing cogs entry with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateCogsEntry","name":"Updates a cogs entry with the specified ID.","isWebhook":false,"pointer":"/paths/~1cogsEntries~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a cogs entry with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing cogs entry with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the cogs entry to update.","required":true}],"pointer":"/paths/~1cogsEntries~1{tenantId}~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/CogsEntry"}},"schemaId":"components/schemas/CogsEntry","pointer":"/paths/~1cogsEntries~1{tenantId}~1{id}/put/requestBody","description":"The updated cogs entry that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/cogsEntries/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CogsEntry"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/cogsEntries/{tenantId}/{id}","href":"cogs-entries/updatecogsentry","openApiOperationId":"updateCogsEntry","summary":"Updates a cogs entry with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/CogsEntry","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CogsEntry"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The cogs entry was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CogsEntry"}},"schemaId":"components/schemas/CogsEntry","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The cogs entry supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The cogs entry could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The cogs entry could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve cogs entry based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1cogsEntries~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CogsEntry","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CogsEntry"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cogs-entries/updatecogsentry"}],"panels":[]}]},"httpPath":"/cogsEntries/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Cogs Entries"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cogs Entries","showPageActions":true},{"nodeType":"markdoc","content":"Cogs Entries"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/cogsEntries/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/cogs-entries/executebatchoperations","deprecated":false},{"title":"/cogsEntries/{tenantId}/fiscalperiod/{fiscal_year_id}/{fiscal_period}","summary":"Returns a list of COGS entries in a fiscal period","prefix":{"name":"get","color":"get"},"badges":[],"link":"/cogs-entries/listcogsentriesbyfiscalperiod","deprecated":false},{"title":"/cogsEntries/{tenantId}/inventoryTransaction/{inventoryTransactionId}","summary":"Returns a list of COGS entries for a transaction ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/cogs-entries/listcogsentriesforinventorytransaction","deprecated":false},{"title":"/cogsEntries/{tenantId}/order/{orderId}","summary":"Returns a list of COGS entries for an order id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/cogs-entries/listcogsentriesfororder","deprecated":false},{"title":"/cogsEntries/{tenantId}/{id}","summary":"Returns a cogs entry from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/cogs-entries/deletecogsentry","deprecated":false},{"title":"/cogsEntries/{tenantId}/{id}","summary":"Returns a cogs entry from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/cogs-entries/getcogsentry","deprecated":false},{"title":"/cogsEntries/{tenantId}/{id}","summary":"Partially updates a cogs entry with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/cogs-entries/patchcogsentry","deprecated":false},{"title":"/cogsEntries/{tenantId}/{id}","summary":"Updates a cogs entry with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/cogs-entries/updatecogsentry","deprecated":false}]}]}]}]}},{"type":"group","label":"Credit Memos","link":"/apis/collect/collect-v1/credit-memos","routeSlug":"/apis/collect/collect-v1/credit-memos","items":[{"label":"Initiates workflow to warm up inventory transactions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/credit-memos/warmupstepfunctions","routeSlug":"/apis/collect/collect-v1/credit-memos/warmupstepfunctions","metadata":{"seo":{"title":"Initiates workflow to warm up inventory transactions","description":"Initiates workflow to warm up inventory transactions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"warmUpStepFunctions","name":"Initiates workflow to warm up inventory transactions","isWebhook":false,"pointer":"/paths/~1creditMemos~1warmUpStepFunctions/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Initiates workflow to warm up inventory transactions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/creditMemos/warmUpStepFunctions","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/creditMemos/warmUpStepFunctions","href":"credit-memos/warmupstepfunctions","openApiOperationId":"warmUpStepFunctions","summary":"Initiates workflow to warm up inventory transactions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Request limit exceeded... please try your request again in a few seconds","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"An internal server error occured.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1creditMemos~1warmUpStepFunctions/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-memos/warmupstepfunctions"}],"panels":[]}]},"httpPath":"/creditMemos/warmUpStepFunctions"},{"label":"Processes a new credit memo","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/credit-memos/processcreditmemo","routeSlug":"/apis/collect/collect-v1/credit-memos/processcreditmemo","metadata":{"seo":{"title":"Processes a new credit memo","description":"This method will auto-generate an ID and create a new credit memo. If an ID is specified for the credit memo, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"processCreditMemo","name":"Processes a new credit memo","isWebhook":false,"pointer":"/paths/~1creditMemos~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Processes a new credit memo","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new credit memo. If an ID is specified for the credit memo, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1creditMemos~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreditMemo"}},"schemaId":"components/schemas/CreditMemo","pointer":"/paths/~1creditMemos~1{tenantId}/post/requestBody","description":"The credit memo that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/creditMemos/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreditMemo"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/creditMemos/{tenantId}","href":"credit-memos/processcreditmemo","openApiOperationId":"processCreditMemo","summary":"Processes a new credit memo"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/CreditMemo","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreditMemo"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The credit memo process was started","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StepFunctionExecutionToken"}},"schemaId":"components/schemas/StepFunctionExecutionToken","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The credit memo you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The credit memo could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add credit memo based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1creditMemos~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/StepFunctionExecutionToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StepFunctionExecutionToken"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-memos/processcreditmemo"}],"panels":[]}]},"httpPath":"/creditMemos/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/credit-memos/executebatchoperations","routeSlug":"/apis/collect/collect-v1/credit-memos/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1creditMemos~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1creditMemos~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1creditMemos~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/creditMemos/{tenantId}/batch","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/creditMemos/{tenantId}/batch","href":"credit-memos/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The credit memo could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve credit memo based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1creditMemos~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-memos/executebatchoperations"}],"panels":[]}]},"httpPath":"/creditMemos/{tenantId}/batch"},{"label":"Returns a list of records with the specified batch_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/credit-memos/listmemosbybatchid","routeSlug":"/apis/collect/collect-v1/credit-memos/listmemosbybatchid","metadata":{"seo":{"title":"Returns a list of records with the specified batch_id","description":"Returns a list of records with the specified batch_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listMemosByBatchId","name":"Returns a list of records with the specified batch_id","isWebhook":false,"pointer":"/paths/~1creditMemos~1{tenantId}~1batch~1{batch_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified batch_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":"Returns a list of records with the specified batch_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The tenant","required":true},{"name":"batch_id","in":"path","schemaId":"schema_409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The batch_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1creditMemos~1{tenantId}~1batch~1{batch_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1creditMemos~1{tenantId}~1batch~1{batch_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/creditMemos/{tenantId}/batch/{batch_id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"batch_id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/creditMemos/{tenantId}/batch/{batch_id}","href":"credit-memos/listmemosbybatchid","openApiOperationId":"listMemosByBatchId","summary":"Returns a list of records with the specified batch_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCreditMemosResponse"}},"schemaId":"components/schemas/ListCreditMemosResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1creditMemos~1{tenantId}~1batch~1{batch_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListCreditMemosResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCreditMemosResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-memos/listmemosbybatchid"}],"panels":[]}]},"httpPath":"/creditMemos/{tenantId}/batch/{batch_id}"},{"label":"Searches for credit memos using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/credit-memos/searchforcreditmemos","routeSlug":"/apis/collect/collect-v1/credit-memos/searchforcreditmemos","metadata":{"seo":{"title":"Searches for credit memos using predefined parameters","description":"Searches for credit memos using predefined parameters"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchForCreditMemos","name":"Searches for credit memos using predefined parameters","isWebhook":false,"pointer":"/paths/~1creditMemos~1{tenantId}~1search/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Searches for credit memos using predefined parameters","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Searches for credit memos using predefined parameters"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1creditMemos~1{tenantId}~1search/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"The start key for the search, for paging support"},{"name":"fieldsToReturn","in":"query","schemaId":"schema_409","description":"  The fields that you want to retrieve; if omitted, the entire object is returned"}],"pointer":"/paths/~1creditMemos~1{tenantId}~1search/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreditMemoSearchParameters"}},"schemaId":"components/schemas/CreditMemoSearchParameters","pointer":"/paths/~1creditMemos~1{tenantId}~1search/post/requestBody","description":"The credit memo that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/creditMemos/{tenantId}/search","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"},{"name":"fieldsToReturn","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreditMemoSearchParameters"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/creditMemos/{tenantId}/search","href":"credit-memos/searchforcreditmemos","openApiOperationId":"searchForCreditMemos","summary":"Searches for credit memos using predefined parameters"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/CreditMemoSearchParameters","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreditMemoSearchParameters"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The credit memo search was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedCreditMemoSearchResults"}},"schemaId":"components/schemas/PagedCreditMemoSearchResults","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The credit memo you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The credit memo could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add credit memo based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1creditMemos~1{tenantId}~1search/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PagedCreditMemoSearchResults","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedCreditMemoSearchResults"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-memos/searchforcreditmemos"}],"panels":[]}]},"httpPath":"/creditMemos/{tenantId}/search"},{"label":"Gets all of the credit memos in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/credit-memos/listcreditmemos","routeSlug":"/apis/collect/collect-v1/credit-memos/listcreditmemos","metadata":{"seo":{"title":"Gets all of the credit memos in the system.","description":"This method will scan all credit memos and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCreditMemos","name":"Gets all of the credit memos in the system.","isWebhook":false,"pointer":"/paths/~1creditMemos~1{tenantId}~1sync/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the credit memos in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all credit memos and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1creditMemos~1{tenantId}~1sync/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1creditMemos~1{tenantId}~1sync/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/creditMemos/{tenantId}/sync","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/creditMemos/{tenantId}/sync","href":"credit-memos/listcreditmemos","openApiOperationId":"listCreditMemos","summary":"Gets all of the credit memos in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The credit memoswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_426"}},"schemaId":"schema_426","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1creditMemos~1{tenantId}~1sync/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_426","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_426"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-memos/listcreditmemos"}],"panels":[]}]},"httpPath":"/creditMemos/{tenantId}/sync"},{"label":"Creates a new credit that doesn't already exist","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/credit-memos/processcreditmemosync","routeSlug":"/apis/collect/collect-v1/credit-memos/processcreditmemosync","metadata":{"seo":{"title":"Creates a new credit that doesn't already exist","description":"This method will auto-generate an ID and create a new credit memo. If an ID is specified for the credit memo, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"processCreditMemoSync","name":"Creates a new credit that doesn't already exist","isWebhook":false,"pointer":"/paths/~1creditMemos~1{tenantId}~1sync/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new credit that doesn't already exist","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new credit memo. If an ID is specified for the credit memo, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1creditMemos~1{tenantId}~1sync/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreditMemo"}},"schemaId":"components/schemas/CreditMemo","pointer":"/paths/~1creditMemos~1{tenantId}~1sync/post/requestBody","description":"The credit memo that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/creditMemos/{tenantId}/sync","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreditMemo"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/creditMemos/{tenantId}/sync","href":"credit-memos/processcreditmemosync","openApiOperationId":"processCreditMemoSync","summary":"Creates a new credit that doesn't already exist"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/CreditMemo","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreditMemo"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The credit memo was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditMemo"}},"schemaId":"components/schemas/CreditMemo","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The credit memo you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The credit memo could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add credit memo based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1creditMemos~1{tenantId}~1sync/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreditMemo","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditMemo"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-memos/processcreditmemosync"}],"panels":[]}]},"httpPath":"/creditMemos/{tenantId}/sync"},{"label":"Returns a credit memo from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/credit-memos/getcreditmemo","routeSlug":"/apis/collect/collect-v1/credit-memos/getcreditmemo","metadata":{"seo":{"title":"Returns a credit memo from the system by its ID.","description":"This method will look up a credit memo by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCreditMemo","name":"Returns a credit memo from the system by its ID.","isWebhook":false,"pointer":"/paths/~1creditMemos~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a credit memo from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a credit memo by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the credit memo to return.","required":true}],"pointer":"/paths/~1creditMemos~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_409","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1creditMemos~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/creditMemos/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/creditMemos/{tenantId}/{id}","href":"credit-memos/getcreditmemo","openApiOperationId":"getCreditMemo","summary":"Returns a credit memo from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The credit memo was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditMemo"}},"schemaId":"components/schemas/CreditMemo","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The credit memo could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve credit memo based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1creditMemos~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreditMemo","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditMemo"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-memos/getcreditmemo"}],"panels":[]}]},"httpPath":"/creditMemos/{tenantId}/{id}"},{"label":"Partially updates a credit memo with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/credit-memos/patchcreditmemo","routeSlug":"/apis/collect/collect-v1/credit-memos/patchcreditmemo","metadata":{"seo":{"title":"Partially updates a credit memo with the specified ID.","description":"This method will patch an existing credit memo with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchCreditMemo","name":"Partially updates a credit memo with the specified ID.","isWebhook":false,"pointer":"/paths/~1creditMemos~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a credit memo with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing credit memo with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the credit memo to patch.","required":true}],"pointer":"/paths/~1creditMemos~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"schemaId":"schema_412","pointer":"/paths/~1creditMemos~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/creditMemos/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_412"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/creditMemos/{tenantId}/{id}","href":"credit-memos/patchcreditmemo","openApiOperationId":"patchCreditMemo","summary":"Partially updates a credit memo with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"schema_412","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The credit memo was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditMemo"}},"schemaId":"components/schemas/CreditMemo","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The credit memo could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The credit memo could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve credit memo based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1creditMemos~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreditMemo","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditMemo"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-memos/patchcreditmemo"}],"panels":[]}]},"httpPath":"/creditMemos/{tenantId}/{id}"},{"label":"Updates a credit memo with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/credit-memos/updatecreditmemo","routeSlug":"/apis/collect/collect-v1/credit-memos/updatecreditmemo","metadata":{"seo":{"title":"Updates a credit memo with the specified ID.","description":"This method will update an existing credit memo with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateCreditMemo","name":"Updates a credit memo with the specified ID.","isWebhook":false,"pointer":"/paths/~1creditMemos~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a credit memo with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing credit memo with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the credit memo to update.","required":true}],"pointer":"/paths/~1creditMemos~1{tenantId}~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/CreditMemo"}},"schemaId":"components/schemas/CreditMemo","pointer":"/paths/~1creditMemos~1{tenantId}~1{id}/put/requestBody","description":"The updated credit memo that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/creditMemos/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreditMemo"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/creditMemos/{tenantId}/{id}","href":"credit-memos/updatecreditmemo","openApiOperationId":"updateCreditMemo","summary":"Updates a credit memo with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/CreditMemo","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreditMemo"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The credit memo was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditMemo"}},"schemaId":"components/schemas/CreditMemo","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The credit memo supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The credit memo could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The credit memo could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve credit memo based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1creditMemos~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CreditMemo","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CreditMemo"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credit-memos/updatecreditmemo"}],"panels":[]}]},"httpPath":"/creditMemos/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Credit Memos"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Credit Memos","showPageActions":true},{"nodeType":"markdoc","content":"Credit Memos"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/creditMemos/warmUpStepFunctions","summary":"Initiates workflow to warm up inventory transactions","prefix":{"name":"post","color":"post"},"badges":[],"link":"/credit-memos/warmupstepfunctions","deprecated":false},{"title":"/creditMemos/{tenantId}","summary":"Processes a new credit memo","prefix":{"name":"post","color":"post"},"badges":[],"link":"/credit-memos/processcreditmemo","deprecated":false},{"title":"/creditMemos/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/credit-memos/executebatchoperations","deprecated":false},{"title":"/creditMemos/{tenantId}/batch/{batch_id}","summary":"Returns a list of records with the specified batch_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/credit-memos/listmemosbybatchid","deprecated":false},{"title":"/creditMemos/{tenantId}/search","summary":"Searches for credit memos using predefined parameters","prefix":{"name":"post","color":"post"},"badges":[],"link":"/credit-memos/searchforcreditmemos","deprecated":false},{"title":"/creditMemos/{tenantId}/sync","summary":"Gets all of the credit memos in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/credit-memos/listcreditmemos","deprecated":false},{"title":"/creditMemos/{tenantId}/sync","summary":"Creates a new credit that doesn't already exist","prefix":{"name":"post","color":"post"},"badges":[],"link":"/credit-memos/processcreditmemosync","deprecated":false},{"title":"/creditMemos/{tenantId}/{id}","summary":"Returns a credit memo from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/credit-memos/getcreditmemo","deprecated":false},{"title":"/creditMemos/{tenantId}/{id}","summary":"Partially updates a credit memo with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/credit-memos/patchcreditmemo","deprecated":false},{"title":"/creditMemos/{tenantId}/{id}","summary":"Updates a credit memo with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/credit-memos/updatecreditmemo","deprecated":false}]}]}]}]}},{"type":"group","label":"Credits","link":"/apis/collect/collect-v1/credits","routeSlug":"/apis/collect/collect-v1/credits","items":[{"label":"Initiates workflow to warm up inventory transactions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/credits/warmupstepfunctions","routeSlug":"/apis/collect/collect-v1/credits/warmupstepfunctions","metadata":{"seo":{"title":"Initiates workflow to warm up inventory transactions","description":"Initiates workflow to warm up inventory transactions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"warmUpStepFunctions","name":"Initiates workflow to warm up inventory transactions","isWebhook":false,"pointer":"/paths/~1credits~1warmUpStepFunctions/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Initiates workflow to warm up inventory transactions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/credits/warmUpStepFunctions","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/credits/warmUpStepFunctions","href":"credits/warmupstepfunctions","openApiOperationId":"warmUpStepFunctions","summary":"Initiates workflow to warm up inventory transactions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Request limit exceeded... please try your request again in a few seconds","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"An internal server error occured.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1credits~1warmUpStepFunctions/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credits/warmupstepfunctions"}],"panels":[]}]},"httpPath":"/credits/warmUpStepFunctions"},{"label":"Gets all of the credits in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/credits/listcredits","routeSlug":"/apis/collect/collect-v1/credits/listcredits","metadata":{"seo":{"title":"Gets all of the credits in the system.","description":"This method will scan all credits and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCredits","name":"Gets all of the credits in the system.","isWebhook":false,"pointer":"/paths/~1credits~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the credits in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all credits and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1credits~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1credits~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/credits/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/credits/{tenantId}","href":"credits/listcredits","openApiOperationId":"listCredits","summary":"Gets all of the credits in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The creditswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_427"}},"schemaId":"schema_427","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1credits~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_427","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_427"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credits/listcredits"}],"panels":[]}]},"httpPath":"/credits/{tenantId}"},{"label":"Creates a new credit record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/credits/processcredit","routeSlug":"/apis/collect/collect-v1/credits/processcredit","metadata":{"seo":{"title":"Creates a new credit record that does not already exist.","description":"This method will auto-generate an ID and create a new credit. If an ID is specified for the credit, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"processCredit","name":"Creates a new credit record that does not already exist.","isWebhook":false,"pointer":"/paths/~1credits~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new credit record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new credit. If an ID is specified for the credit, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1credits~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Credit"}},"schemaId":"components/schemas/Credit","pointer":"/paths/~1credits~1{tenantId}/post/requestBody","description":"The credit that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/credits/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Credit"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/credits/{tenantId}","href":"credits/processcredit","openApiOperationId":"processCredit","summary":"Creates a new credit record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Credit","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Credit"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The credit process was started successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StepFunctionExecutionToken"}},"schemaId":"components/schemas/StepFunctionExecutionToken","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The credit you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The credit could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add credit based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1credits~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/StepFunctionExecutionToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StepFunctionExecutionToken"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credits/processcredit"}],"panels":[]}]},"httpPath":"/credits/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/credits/executebatchoperations","routeSlug":"/apis/collect/collect-v1/credits/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1credits~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1credits~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1credits~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/credits/{tenantId}/batch","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/credits/{tenantId}/batch","href":"credits/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The credit could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve credit based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1credits~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credits/executebatchoperations"}],"panels":[]}]},"httpPath":"/credits/{tenantId}/batch"},{"label":"Returns a list of records with the specified batch_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/credits/listcreditsbybatchid","routeSlug":"/apis/collect/collect-v1/credits/listcreditsbybatchid","metadata":{"seo":{"title":"Returns a list of records with the specified batch_id","description":"Returns a list of records with the specified batch_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCreditsByBatchId","name":"Returns a list of records with the specified batch_id","isWebhook":false,"pointer":"/paths/~1credits~1{tenantId}~1batch~1{batch_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified batch_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":"Returns a list of records with the specified batch_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The tenant","required":true},{"name":"batch_id","in":"path","schemaId":"schema_409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The batch_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1credits~1{tenantId}~1batch~1{batch_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1credits~1{tenantId}~1batch~1{batch_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/credits/{tenantId}/batch/{batch_id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"batch_id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/credits/{tenantId}/batch/{batch_id}","href":"credits/listcreditsbybatchid","openApiOperationId":"listCreditsByBatchId","summary":"Returns a list of records with the specified batch_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCreditsResponse"}},"schemaId":"components/schemas/ListCreditsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1credits~1{tenantId}~1batch~1{batch_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListCreditsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCreditsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credits/listcreditsbybatchid"}],"panels":[]}]},"httpPath":"/credits/{tenantId}/batch/{batch_id}"},{"label":"Returns a list of records with the specified contact_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/credits/listcreditsbycontactid","routeSlug":"/apis/collect/collect-v1/credits/listcreditsbycontactid","metadata":{"seo":{"title":"Returns a list of records with the specified contact_id","description":"Returns a list of records with the specified contact_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCreditsByContactId","name":"Returns a list of records with the specified contact_id","isWebhook":false,"pointer":"/paths/~1credits~1{tenantId}~1contact~1{contact_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified contact_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":"Returns a list of records with the specified contact_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The tenant","required":true},{"name":"contact_id","in":"path","schemaId":"schema_409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contact_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1credits~1{tenantId}~1contact~1{contact_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"onlyIncludeOpenCredits","in":"query","schemaId":"schema_428","description":"If set, only open credits are included"},{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1credits~1{tenantId}~1contact~1{contact_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/credits/{tenantId}/contact/{contact_id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"contact_id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"onlyIncludeOpenCredits","in":"query","required":false,"schemaId":"schema_428"},{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/credits/{tenantId}/contact/{contact_id}","href":"credits/listcreditsbycontactid","openApiOperationId":"listCreditsByContactId","summary":"Returns a list of records with the specified contact_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCreditsResponse"}},"schemaId":"components/schemas/ListCreditsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1credits~1{tenantId}~1contact~1{contact_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListCreditsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCreditsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credits/listcreditsbycontactid"}],"panels":[]}]},"httpPath":"/credits/{tenantId}/contact/{contact_id}"},{"label":"Creates a new credit record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/credits/createcredit","routeSlug":"/apis/collect/collect-v1/credits/createcredit","metadata":{"seo":{"title":"Creates a new credit record that does not already exist.","description":"This method will auto-generate an ID and create a new credit. If an ID is specified for the credit, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createCredit","name":"Creates a new credit record that does not already exist.","isWebhook":false,"pointer":"/paths/~1credits~1{tenantId}~1manual/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new credit record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new credit. If an ID is specified for the credit, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1credits~1{tenantId}~1manual/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Credit"}},"schemaId":"components/schemas/Credit","pointer":"/paths/~1credits~1{tenantId}~1manual/post/requestBody","description":"The credit that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/credits/{tenantId}/manual","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Credit"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/credits/{tenantId}/manual","href":"credits/createcredit","openApiOperationId":"createCredit","summary":"Creates a new credit record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Credit","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Credit"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The credit was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Credit"}},"schemaId":"components/schemas/Credit","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The credit you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The credit could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add credit based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1credits~1{tenantId}~1manual/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Credit","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Credit"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credits/createcredit"}],"panels":[]}]},"httpPath":"/credits/{tenantId}/manual"},{"label":"Returns a list of records with the specified organization_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/credits/listcreditsbyorganizationid","routeSlug":"/apis/collect/collect-v1/credits/listcreditsbyorganizationid","metadata":{"seo":{"title":"Returns a list of records with the specified organization_id","description":"Returns a list of records with the specified organization_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCreditsByOrganizationId","name":"Returns a list of records with the specified organization_id","isWebhook":false,"pointer":"/paths/~1credits~1{tenantId}~1organization~1{organization_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified organization_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":"Returns a list of records with the specified organization_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The tenant","required":true},{"name":"organization_id","in":"path","schemaId":"schema_409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The organization_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1credits~1{tenantId}~1organization~1{organization_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"onlyIncludeOpenCredits","in":"query","schemaId":"schema_428","description":"If set, only open credits are included"},{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1credits~1{tenantId}~1organization~1{organization_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/credits/{tenantId}/organization/{organization_id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"organization_id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"onlyIncludeOpenCredits","in":"query","required":false,"schemaId":"schema_428"},{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/credits/{tenantId}/organization/{organization_id}","href":"credits/listcreditsbyorganizationid","openApiOperationId":"listCreditsByOrganizationId","summary":"Returns a list of records with the specified organization_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCreditsResponse"}},"schemaId":"components/schemas/ListCreditsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1credits~1{tenantId}~1organization~1{organization_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListCreditsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCreditsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credits/listcreditsbyorganizationid"}],"panels":[]}]},"httpPath":"/credits/{tenantId}/organization/{organization_id}"},{"label":"Returns a list of records with the specified owner_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/credits/listcreditsbyownerid","routeSlug":"/apis/collect/collect-v1/credits/listcreditsbyownerid","metadata":{"seo":{"title":"Returns a list of records with the specified owner_id","description":"Returns a list of records with the specified owner_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCreditsByOwnerId","name":"Returns a list of records with the specified owner_id","isWebhook":false,"pointer":"/paths/~1credits~1{tenantId}~1owner~1{owner_type}~1{owner_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified owner_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":"Returns a list of records with the specified owner_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The tenant","required":true},{"name":"owner_type","in":"path","schemaId":"schema_409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The owner_type to use to for record lookup"},"children":[]}]}]}],"required":true},{"name":"owner_id","in":"path","schemaId":"schema_409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The owner_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1credits~1{tenantId}~1owner~1{owner_type}~1{owner_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"onlyIncludeOpenCredits","in":"query","schemaId":"schema_428","description":"If set, only open credits are included"},{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1credits~1{tenantId}~1owner~1{owner_type}~1{owner_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/credits/{tenantId}/owner/{owner_type}/{owner_id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"owner_type","in":"path","required":true,"schemaId":"schema_409"},{"name":"owner_id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"onlyIncludeOpenCredits","in":"query","required":false,"schemaId":"schema_428"},{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/credits/{tenantId}/owner/{owner_type}/{owner_id}","href":"credits/listcreditsbyownerid","openApiOperationId":"listCreditsByOwnerId","summary":"Returns a list of records with the specified owner_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCreditsResponse"}},"schemaId":"components/schemas/ListCreditsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1credits~1{tenantId}~1owner~1{owner_type}~1{owner_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListCreditsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListCreditsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credits/listcreditsbyownerid"}],"panels":[]}]},"httpPath":"/credits/{tenantId}/owner/{owner_type}/{owner_id}"},{"label":"Searches for credits using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/credits/searchforcredits","routeSlug":"/apis/collect/collect-v1/credits/searchforcredits","metadata":{"seo":{"title":"Searches for credits using predefined parameters","description":"Searches for credits using predefined parameters"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchForCredits","name":"Searches for credits using predefined parameters","isWebhook":false,"pointer":"/paths/~1credits~1{tenantId}~1search/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Searches for credits using predefined parameters","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Searches for credits using predefined parameters"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1credits~1{tenantId}~1search/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"The start key for the search, for paging support"},{"name":"fieldsToReturn","in":"query","schemaId":"schema_409","description":"  The fields that you want to retrieve; if omitted, the entire object is returned"}],"pointer":"/paths/~1credits~1{tenantId}~1search/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreditMemoSearchParameters"}},"schemaId":"components/schemas/CreditMemoSearchParameters","pointer":"/paths/~1credits~1{tenantId}~1search/post/requestBody","description":"The credit that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/credits/{tenantId}/search","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"},{"name":"fieldsToReturn","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreditMemoSearchParameters"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/credits/{tenantId}/search","href":"credits/searchforcredits","openApiOperationId":"searchForCredits","summary":"Searches for credits using predefined parameters"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/CreditMemoSearchParameters","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreditMemoSearchParameters"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The credit search was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedCreditSearchResults"}},"schemaId":"components/schemas/PagedCreditSearchResults","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The credit you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The credit could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add credit based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1credits~1{tenantId}~1search/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PagedCreditSearchResults","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedCreditSearchResults"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credits/searchforcredits"}],"panels":[]}]},"httpPath":"/credits/{tenantId}/search"},{"label":"Creates a new credit that doesn't already exist","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/credits/processcreditsync","routeSlug":"/apis/collect/collect-v1/credits/processcreditsync","metadata":{"seo":{"title":"Creates a new credit that doesn't already exist","description":"This method will auto-generate an ID and create a new credit. If an ID is specified for the credit, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"processCreditSync","name":"Creates a new credit that doesn't already exist","isWebhook":false,"pointer":"/paths/~1credits~1{tenantId}~1sync/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new credit that doesn't already exist","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new credit. If an ID is specified for the credit, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1credits~1{tenantId}~1sync/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Credit"}},"schemaId":"components/schemas/Credit","pointer":"/paths/~1credits~1{tenantId}~1sync/post/requestBody","description":"The credit that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/credits/{tenantId}/sync","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Credit"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/credits/{tenantId}/sync","href":"credits/processcreditsync","openApiOperationId":"processCreditSync","summary":"Creates a new credit that doesn't already exist"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Credit","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Credit"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The credit was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Credit"}},"schemaId":"components/schemas/Credit","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The credit you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The credit could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add credit based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1credits~1{tenantId}~1sync/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Credit","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Credit"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credits/processcreditsync"}],"panels":[]}]},"httpPath":"/credits/{tenantId}/sync"},{"label":"Returns a credit from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/credits/deletecredit","routeSlug":"/apis/collect/collect-v1/credits/deletecredit","metadata":{"seo":{"title":"Returns a credit from the system by its ID.","description":"This method will delete a credit with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteCredit","name":"Returns a credit from the system by its ID.","isWebhook":false,"pointer":"/paths/~1credits~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a credit from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a credit with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the credit to delete.","required":true}],"pointer":"/paths/~1credits~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/credits/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/credits/{tenantId}/{id}","href":"credits/deletecredit","openApiOperationId":"deleteCredit","summary":"Returns a credit from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The credit was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}},"schemaId":"schema_409","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The credit could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The credit could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to delete credit based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1credits~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_409","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credits/deletecredit"}],"panels":[]}]},"httpPath":"/credits/{tenantId}/{id}"},{"label":"Returns a credit from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/credits/getcredit","routeSlug":"/apis/collect/collect-v1/credits/getcredit","metadata":{"seo":{"title":"Returns a credit from the system by its ID.","description":"This method will look up a credit by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCredit","name":"Returns a credit from the system by its ID.","isWebhook":false,"pointer":"/paths/~1credits~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a credit from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a credit by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the credit to return.","required":true}],"pointer":"/paths/~1credits~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_409","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1credits~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/credits/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/credits/{tenantId}/{id}","href":"credits/getcredit","openApiOperationId":"getCredit","summary":"Returns a credit from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The credit was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Credit"}},"schemaId":"components/schemas/Credit","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The credit could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve credit based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1credits~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Credit","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Credit"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credits/getcredit"}],"panels":[]}]},"httpPath":"/credits/{tenantId}/{id}"},{"label":"Partially updates a credit with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/credits/patchcredit","routeSlug":"/apis/collect/collect-v1/credits/patchcredit","metadata":{"seo":{"title":"Partially updates a credit with the specified ID.","description":"This method will patch an existing credit with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchCredit","name":"Partially updates a credit with the specified ID.","isWebhook":false,"pointer":"/paths/~1credits~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a credit with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing credit with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the credit to patch.","required":true}],"pointer":"/paths/~1credits~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"schemaId":"schema_412","pointer":"/paths/~1credits~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/credits/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_412"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/credits/{tenantId}/{id}","href":"credits/patchcredit","openApiOperationId":"patchCredit","summary":"Partially updates a credit with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"schema_412","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The credit was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Credit"}},"schemaId":"components/schemas/Credit","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The credit could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The credit could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve credit based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1credits~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Credit","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Credit"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credits/patchcredit"}],"panels":[]}]},"httpPath":"/credits/{tenantId}/{id}"},{"label":"Updates a credit with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/credits/updatecredit","routeSlug":"/apis/collect/collect-v1/credits/updatecredit","metadata":{"seo":{"title":"Updates a credit with the specified ID.","description":"This method will update an existing credit with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateCredit","name":"Updates a credit with the specified ID.","isWebhook":false,"pointer":"/paths/~1credits~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a credit with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing credit with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the credit to update.","required":true}],"pointer":"/paths/~1credits~1{tenantId}~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/Credit"}},"schemaId":"components/schemas/Credit","pointer":"/paths/~1credits~1{tenantId}~1{id}/put/requestBody","description":"The updated credit that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/credits/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Credit"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/credits/{tenantId}/{id}","href":"credits/updatecredit","openApiOperationId":"updateCredit","summary":"Updates a credit with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Credit","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Credit"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The credit was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Credit"}},"schemaId":"components/schemas/Credit","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The credit supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The credit could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The credit could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve credit based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1credits~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Credit","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Credit"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/credits/updatecredit"}],"panels":[]}]},"httpPath":"/credits/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Credits"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Credits","showPageActions":true},{"nodeType":"markdoc","content":"Credits"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/credits/warmUpStepFunctions","summary":"Initiates workflow to warm up inventory transactions","prefix":{"name":"post","color":"post"},"badges":[],"link":"/credits/warmupstepfunctions","deprecated":false},{"title":"/credits/{tenantId}","summary":"Gets all of the credits in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/credits/listcredits","deprecated":false},{"title":"/credits/{tenantId}","summary":"Creates a new credit record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/credits/processcredit","deprecated":false},{"title":"/credits/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/credits/executebatchoperations","deprecated":false},{"title":"/credits/{tenantId}/batch/{batch_id}","summary":"Returns a list of records with the specified batch_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/credits/listcreditsbybatchid","deprecated":false},{"title":"/credits/{tenantId}/contact/{contact_id}","summary":"Returns a list of records with the specified contact_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/credits/listcreditsbycontactid","deprecated":false},{"title":"/credits/{tenantId}/manual","summary":"Creates a new credit record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/credits/createcredit","deprecated":false},{"title":"/credits/{tenantId}/organization/{organization_id}","summary":"Returns a list of records with the specified organization_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/credits/listcreditsbyorganizationid","deprecated":false},{"title":"/credits/{tenantId}/owner/{owner_type}/{owner_id}","summary":"Returns a list of records with the specified owner_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/credits/listcreditsbyownerid","deprecated":false},{"title":"/credits/{tenantId}/search","summary":"Searches for credits using predefined parameters","prefix":{"name":"post","color":"post"},"badges":[],"link":"/credits/searchforcredits","deprecated":false},{"title":"/credits/{tenantId}/sync","summary":"Creates a new credit that doesn't already exist","prefix":{"name":"post","color":"post"},"badges":[],"link":"/credits/processcreditsync","deprecated":false},{"title":"/credits/{tenantId}/{id}","summary":"Returns a credit from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/credits/deletecredit","deprecated":false},{"title":"/credits/{tenantId}/{id}","summary":"Returns a credit from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/credits/getcredit","deprecated":false},{"title":"/credits/{tenantId}/{id}","summary":"Partially updates a credit with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/credits/patchcredit","deprecated":false},{"title":"/credits/{tenantId}/{id}","summary":"Updates a credit with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/credits/updatecredit","deprecated":false}]}]}]}]}},{"type":"group","label":"Currency Mapping Policies","link":"/apis/collect/collect-v1/currency-mapping-policies","routeSlug":"/apis/collect/collect-v1/currency-mapping-policies","items":[{"label":"Gets all of the currency mapping policies in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/currency-mapping-policies/listcurrencymappingpolicies","routeSlug":"/apis/collect/collect-v1/currency-mapping-policies/listcurrencymappingpolicies","metadata":{"seo":{"title":"Gets all of the currency mapping policies in the system.","description":"This method will scan all currency mapping policies and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCurrencyMappingPolicies","name":"Gets all of the currency mapping policies in the system.","isWebhook":false,"pointer":"/paths/~1currencyMappingPolicies~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the currency mapping policies in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all currency mapping policies and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1currencyMappingPolicies~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1currencyMappingPolicies~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/currencyMappingPolicies/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/currencyMappingPolicies/{tenantId}","href":"currency-mapping-policies/listcurrencymappingpolicies","openApiOperationId":"listCurrencyMappingPolicies","summary":"Gets all of the currency mapping policies in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The currency mapping policieswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_429"}},"schemaId":"schema_429","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1currencyMappingPolicies~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_429","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_429"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/currency-mapping-policies/listcurrencymappingpolicies"}],"panels":[]}]},"httpPath":"/currencyMappingPolicies/{tenantId}"},{"label":"Creates a new currency mapping policy record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/currency-mapping-policies/createcurrencymappingpolicy","routeSlug":"/apis/collect/collect-v1/currency-mapping-policies/createcurrencymappingpolicy","metadata":{"seo":{"title":"Creates a new currency mapping policy record that does not already exist.","description":"This method will auto-generate an ID and create a new currency mapping policy. If an ID is specified for the currency mapping policy, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createCurrencyMappingPolicy","name":"Creates a new currency mapping policy record that does not already exist.","isWebhook":false,"pointer":"/paths/~1currencyMappingPolicies~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new currency mapping policy record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new currency mapping policy. If an ID is specified for the currency mapping policy, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1currencyMappingPolicies~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CurrencyMappingPolicy"}},"schemaId":"components/schemas/CurrencyMappingPolicy","pointer":"/paths/~1currencyMappingPolicies~1{tenantId}/post/requestBody","description":"The currency mapping policy that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/currencyMappingPolicies/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CurrencyMappingPolicy"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/currencyMappingPolicies/{tenantId}","href":"currency-mapping-policies/createcurrencymappingpolicy","openApiOperationId":"createCurrencyMappingPolicy","summary":"Creates a new currency mapping policy record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/CurrencyMappingPolicy","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CurrencyMappingPolicy"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The currency mapping policy was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CurrencyMappingPolicy"}},"schemaId":"components/schemas/CurrencyMappingPolicy","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The currency mapping policy you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The currency mapping policy could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add currency mapping policy based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1currencyMappingPolicies~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CurrencyMappingPolicy","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CurrencyMappingPolicy"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/currency-mapping-policies/createcurrencymappingpolicy"}],"panels":[]}]},"httpPath":"/currencyMappingPolicies/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/currency-mapping-policies/executebatchoperations","routeSlug":"/apis/collect/collect-v1/currency-mapping-policies/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1currencyMappingPolicies~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1currencyMappingPolicies~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1currencyMappingPolicies~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/currencyMappingPolicies/{tenantId}/batch","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/currencyMappingPolicies/{tenantId}/batch","href":"currency-mapping-policies/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The currency mapping policy could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve currency mapping policy based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1currencyMappingPolicies~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/currency-mapping-policies/executebatchoperations"}],"panels":[]}]},"httpPath":"/currencyMappingPolicies/{tenantId}/batch"},{"label":"Returns a currency mapping policy from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/currency-mapping-policies/deletecurrencymappingpolicy","routeSlug":"/apis/collect/collect-v1/currency-mapping-policies/deletecurrencymappingpolicy","metadata":{"seo":{"title":"Returns a currency mapping policy from the system by its ID.","description":"This method will delete a currency mapping policy with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteCurrencyMappingPolicy","name":"Returns a currency mapping policy from the system by its ID.","isWebhook":false,"pointer":"/paths/~1currencyMappingPolicies~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a currency mapping policy from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a currency mapping policy with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the currency mapping policy to delete.","required":true}],"pointer":"/paths/~1currencyMappingPolicies~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/currencyMappingPolicies/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/currencyMappingPolicies/{tenantId}/{id}","href":"currency-mapping-policies/deletecurrencymappingpolicy","openApiOperationId":"deleteCurrencyMappingPolicy","summary":"Returns a currency mapping policy from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The currency mapping policy was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}},"schemaId":"schema_409","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The currency mapping policy could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The currency mapping policy could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to delete currency mapping policy based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1currencyMappingPolicies~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_409","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/currency-mapping-policies/deletecurrencymappingpolicy"}],"panels":[]}]},"httpPath":"/currencyMappingPolicies/{tenantId}/{id}"},{"label":"Returns a currency mapping policy from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/currency-mapping-policies/getcurrencymappingpolicy","routeSlug":"/apis/collect/collect-v1/currency-mapping-policies/getcurrencymappingpolicy","metadata":{"seo":{"title":"Returns a currency mapping policy from the system by its ID.","description":"This method will look up a currency mapping policy by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCurrencyMappingPolicy","name":"Returns a currency mapping policy from the system by its ID.","isWebhook":false,"pointer":"/paths/~1currencyMappingPolicies~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a currency mapping policy from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a currency mapping policy by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the currency mapping policy to return.","required":true}],"pointer":"/paths/~1currencyMappingPolicies~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_409","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1currencyMappingPolicies~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/currencyMappingPolicies/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/currencyMappingPolicies/{tenantId}/{id}","href":"currency-mapping-policies/getcurrencymappingpolicy","openApiOperationId":"getCurrencyMappingPolicy","summary":"Returns a currency mapping policy from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The currency mapping policy was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CurrencyMappingPolicy"}},"schemaId":"components/schemas/CurrencyMappingPolicy","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The currency mapping policy could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve currency mapping policy based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1currencyMappingPolicies~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CurrencyMappingPolicy","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CurrencyMappingPolicy"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/currency-mapping-policies/getcurrencymappingpolicy"}],"panels":[]}]},"httpPath":"/currencyMappingPolicies/{tenantId}/{id}"},{"label":"Partially updates a currency mapping policy with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/currency-mapping-policies/patchcurrencymappingpolicy","routeSlug":"/apis/collect/collect-v1/currency-mapping-policies/patchcurrencymappingpolicy","metadata":{"seo":{"title":"Partially updates a currency mapping policy with the specified ID.","description":"This method will patch an existing currency mapping policy with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchCurrencyMappingPolicy","name":"Partially updates a currency mapping policy with the specified ID.","isWebhook":false,"pointer":"/paths/~1currencyMappingPolicies~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a currency mapping policy with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing currency mapping policy with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the currency mapping policy to patch.","required":true}],"pointer":"/paths/~1currencyMappingPolicies~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"schemaId":"schema_412","pointer":"/paths/~1currencyMappingPolicies~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/currencyMappingPolicies/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_412"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/currencyMappingPolicies/{tenantId}/{id}","href":"currency-mapping-policies/patchcurrencymappingpolicy","openApiOperationId":"patchCurrencyMappingPolicy","summary":"Partially updates a currency mapping policy with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"schema_412","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The currency mapping policy was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CurrencyMappingPolicy"}},"schemaId":"components/schemas/CurrencyMappingPolicy","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The currency mapping policy could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The currency mapping policy could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve currency mapping policy based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1currencyMappingPolicies~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CurrencyMappingPolicy","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CurrencyMappingPolicy"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/currency-mapping-policies/patchcurrencymappingpolicy"}],"panels":[]}]},"httpPath":"/currencyMappingPolicies/{tenantId}/{id}"},{"label":"Updates a currency mapping policy with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/currency-mapping-policies/updatecurrencymappingpolicy","routeSlug":"/apis/collect/collect-v1/currency-mapping-policies/updatecurrencymappingpolicy","metadata":{"seo":{"title":"Updates a currency mapping policy with the specified ID.","description":"This method will update an existing currency mapping policy with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateCurrencyMappingPolicy","name":"Updates a currency mapping policy with the specified ID.","isWebhook":false,"pointer":"/paths/~1currencyMappingPolicies~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a currency mapping policy with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing currency mapping policy with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the currency mapping policy to update.","required":true}],"pointer":"/paths/~1currencyMappingPolicies~1{tenantId}~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/CurrencyMappingPolicy"}},"schemaId":"components/schemas/CurrencyMappingPolicy","pointer":"/paths/~1currencyMappingPolicies~1{tenantId}~1{id}/put/requestBody","description":"The updated currency mapping policy that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/currencyMappingPolicies/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CurrencyMappingPolicy"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/currencyMappingPolicies/{tenantId}/{id}","href":"currency-mapping-policies/updatecurrencymappingpolicy","openApiOperationId":"updateCurrencyMappingPolicy","summary":"Updates a currency mapping policy with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/CurrencyMappingPolicy","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CurrencyMappingPolicy"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The currency mapping policy was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CurrencyMappingPolicy"}},"schemaId":"components/schemas/CurrencyMappingPolicy","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The currency mapping policy supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The currency mapping policy could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The currency mapping policy could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve currency mapping policy based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1currencyMappingPolicies~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/CurrencyMappingPolicy","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/CurrencyMappingPolicy"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/currency-mapping-policies/updatecurrencymappingpolicy"}],"panels":[]}]},"httpPath":"/currencyMappingPolicies/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Currency Mapping Policies"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Currency Mapping Policies","showPageActions":true},{"nodeType":"markdoc","content":"Currency Mapping Policies"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/currencyMappingPolicies/{tenantId}","summary":"Gets all of the currency mapping policies in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/currency-mapping-policies/listcurrencymappingpolicies","deprecated":false},{"title":"/currencyMappingPolicies/{tenantId}","summary":"Creates a new currency mapping policy record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/currency-mapping-policies/createcurrencymappingpolicy","deprecated":false},{"title":"/currencyMappingPolicies/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/currency-mapping-policies/executebatchoperations","deprecated":false},{"title":"/currencyMappingPolicies/{tenantId}/{id}","summary":"Returns a currency mapping policy from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/currency-mapping-policies/deletecurrencymappingpolicy","deprecated":false},{"title":"/currencyMappingPolicies/{tenantId}/{id}","summary":"Returns a currency mapping policy from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/currency-mapping-policies/getcurrencymappingpolicy","deprecated":false},{"title":"/currencyMappingPolicies/{tenantId}/{id}","summary":"Partially updates a currency mapping policy with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/currency-mapping-policies/patchcurrencymappingpolicy","deprecated":false},{"title":"/currencyMappingPolicies/{tenantId}/{id}","summary":"Updates a currency mapping policy with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/currency-mapping-policies/updatecurrencymappingpolicy","deprecated":false}]}]}]}]}},{"type":"group","label":"Debit Memos","link":"/apis/collect/collect-v1/debit-memos","routeSlug":"/apis/collect/collect-v1/debit-memos","items":[{"label":"Initiates workflow to warm up inventory transactions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/debit-memos/warmupstepfunctions","routeSlug":"/apis/collect/collect-v1/debit-memos/warmupstepfunctions","metadata":{"seo":{"title":"Initiates workflow to warm up inventory transactions","description":"Initiates workflow to warm up inventory transactions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"warmUpStepFunctions","name":"Initiates workflow to warm up inventory transactions","isWebhook":false,"pointer":"/paths/~1debitMemos~1warmUpStepFunctions/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Initiates workflow to warm up inventory transactions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/debitMemos/warmUpStepFunctions","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/debitMemos/warmUpStepFunctions","href":"debit-memos/warmupstepfunctions","openApiOperationId":"warmUpStepFunctions","summary":"Initiates workflow to warm up inventory transactions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Request limit exceeded... please try your request again in a few seconds","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"An internal server error occured.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1debitMemos~1warmUpStepFunctions/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/debit-memos/warmupstepfunctions"}],"panels":[]}]},"httpPath":"/debitMemos/warmUpStepFunctions"},{"label":"Gets all of the debit memos in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/debit-memos/listdebitmemos","routeSlug":"/apis/collect/collect-v1/debit-memos/listdebitmemos","metadata":{"seo":{"title":"Gets all of the debit memos in the system.","description":"This method will scan all debit memos and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listDebitMemos","name":"Gets all of the debit memos in the system.","isWebhook":false,"pointer":"/paths/~1debitMemos~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the debit memos in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all debit memos and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1debitMemos~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1debitMemos~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/debitMemos/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/debitMemos/{tenantId}","href":"debit-memos/listdebitmemos","openApiOperationId":"listDebitMemos","summary":"Gets all of the debit memos in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The debit memoswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_430"}},"schemaId":"schema_430","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1debitMemos~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_430","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_430"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/debit-memos/listdebitmemos"}],"panels":[]}]},"httpPath":"/debitMemos/{tenantId}"},{"label":"Processes a new debit memo","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/debit-memos/processdebitmemo","routeSlug":"/apis/collect/collect-v1/debit-memos/processdebitmemo","metadata":{"seo":{"title":"Processes a new debit memo","description":"This method will auto-generate an ID and create a new debit memo. If an ID is specified for the debit memo, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"processDebitMemo","name":"Processes a new debit memo","isWebhook":false,"pointer":"/paths/~1debitMemos~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Processes a new debit memo","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new debit memo. If an ID is specified for the debit memo, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1debitMemos~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DebitMemo"}},"schemaId":"components/schemas/DebitMemo","pointer":"/paths/~1debitMemos~1{tenantId}/post/requestBody","description":"The debit memo that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/debitMemos/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DebitMemo"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/debitMemos/{tenantId}","href":"debit-memos/processdebitmemo","openApiOperationId":"processDebitMemo","summary":"Processes a new debit memo"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/DebitMemo","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DebitMemo"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The debit memo was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StepFunctionExecutionToken"}},"schemaId":"components/schemas/StepFunctionExecutionToken","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The debit memo you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The debit memo could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add debit memo based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1debitMemos~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/StepFunctionExecutionToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StepFunctionExecutionToken"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/debit-memos/processdebitmemo"}],"panels":[]}]},"httpPath":"/debitMemos/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/debit-memos/executebatchoperations","routeSlug":"/apis/collect/collect-v1/debit-memos/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1debitMemos~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1debitMemos~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1debitMemos~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/debitMemos/{tenantId}/batch","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/debitMemos/{tenantId}/batch","href":"debit-memos/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The debit memo could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve debit memo based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1debitMemos~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/debit-memos/executebatchoperations"}],"panels":[]}]},"httpPath":"/debitMemos/{tenantId}/batch"},{"label":"Returns a list of records with the specified batch_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/debit-memos/listmemosbybatchid","routeSlug":"/apis/collect/collect-v1/debit-memos/listmemosbybatchid","metadata":{"seo":{"title":"Returns a list of records with the specified batch_id","description":"Returns a list of records with the specified batch_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listMemosByBatchId","name":"Returns a list of records with the specified batch_id","isWebhook":false,"pointer":"/paths/~1debitMemos~1{tenantId}~1batch~1{batch_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified batch_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":"Returns a list of records with the specified batch_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The tenant","required":true},{"name":"batch_id","in":"path","schemaId":"schema_409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The batch_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1debitMemos~1{tenantId}~1batch~1{batch_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1debitMemos~1{tenantId}~1batch~1{batch_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/debitMemos/{tenantId}/batch/{batch_id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"batch_id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/debitMemos/{tenantId}/batch/{batch_id}","href":"debit-memos/listmemosbybatchid","openApiOperationId":"listMemosByBatchId","summary":"Returns a list of records with the specified batch_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListDebitMemosResponse"}},"schemaId":"components/schemas/ListDebitMemosResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1debitMemos~1{tenantId}~1batch~1{batch_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListDebitMemosResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListDebitMemosResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/debit-memos/listmemosbybatchid"}],"panels":[]}]},"httpPath":"/debitMemos/{tenantId}/batch/{batch_id}"},{"label":"Searches for debit memos using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/debit-memos/searchfordebitmemos","routeSlug":"/apis/collect/collect-v1/debit-memos/searchfordebitmemos","metadata":{"seo":{"title":"Searches for debit memos using predefined parameters","description":"Searches for debit memos using predefined parameters"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchForDebitMemos","name":"Searches for debit memos using predefined parameters","isWebhook":false,"pointer":"/paths/~1debitMemos~1{tenantId}~1search/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Searches for debit memos using predefined parameters","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Searches for debit memos using predefined parameters"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1debitMemos~1{tenantId}~1search/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"The start key for the search, for paging support"},{"name":"fieldsToReturn","in":"query","schemaId":"schema_409","description":"  The fields that you want to retrieve; if omitted, the entire object is returned"}],"pointer":"/paths/~1debitMemos~1{tenantId}~1search/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreditMemoSearchParameters"}},"schemaId":"components/schemas/CreditMemoSearchParameters","pointer":"/paths/~1debitMemos~1{tenantId}~1search/post/requestBody","description":"The debit memo that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/debitMemos/{tenantId}/search","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"},{"name":"fieldsToReturn","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreditMemoSearchParameters"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/debitMemos/{tenantId}/search","href":"debit-memos/searchfordebitmemos","openApiOperationId":"searchForDebitMemos","summary":"Searches for debit memos using predefined parameters"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/CreditMemoSearchParameters","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreditMemoSearchParameters"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The debit memo search was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedDebitMemoSearchResults"}},"schemaId":"components/schemas/PagedDebitMemoSearchResults","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The debit memo you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The debit memo could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add debit memo based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1debitMemos~1{tenantId}~1search/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PagedDebitMemoSearchResults","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedDebitMemoSearchResults"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/debit-memos/searchfordebitmemos"}],"panels":[]}]},"httpPath":"/debitMemos/{tenantId}/search"},{"label":"Creates a new debit that doesn't already exist","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/debit-memos/processdebitmemosync","routeSlug":"/apis/collect/collect-v1/debit-memos/processdebitmemosync","metadata":{"seo":{"title":"Creates a new debit that doesn't already exist","description":"This method will auto-generate an ID and create a new debit memo. If an ID is specified for the debit memo, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"processDebitMemoSync","name":"Creates a new debit that doesn't already exist","isWebhook":false,"pointer":"/paths/~1debitMemos~1{tenantId}~1sync/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new debit that doesn't already exist","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new debit memo. If an ID is specified for the debit memo, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1debitMemos~1{tenantId}~1sync/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DebitMemo"}},"schemaId":"components/schemas/DebitMemo","pointer":"/paths/~1debitMemos~1{tenantId}~1sync/post/requestBody","description":"The debit memo that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/debitMemos/{tenantId}/sync","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DebitMemo"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/debitMemos/{tenantId}/sync","href":"debit-memos/processdebitmemosync","openApiOperationId":"processDebitMemoSync","summary":"Creates a new debit that doesn't already exist"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/DebitMemo","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DebitMemo"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The debit memo was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DebitMemo"}},"schemaId":"components/schemas/DebitMemo","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The debit memo you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The debit memo could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add debit memo based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1debitMemos~1{tenantId}~1sync/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DebitMemo","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DebitMemo"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/debit-memos/processdebitmemosync"}],"panels":[]}]},"httpPath":"/debitMemos/{tenantId}/sync"},{"label":"Returns a debit memo from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/debit-memos/getdebitmemo","routeSlug":"/apis/collect/collect-v1/debit-memos/getdebitmemo","metadata":{"seo":{"title":"Returns a debit memo from the system by its ID.","description":"This method will look up a debit memo by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDebitMemo","name":"Returns a debit memo from the system by its ID.","isWebhook":false,"pointer":"/paths/~1debitMemos~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a debit memo from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a debit memo by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the debit memo to return.","required":true}],"pointer":"/paths/~1debitMemos~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_409","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1debitMemos~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/debitMemos/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/debitMemos/{tenantId}/{id}","href":"debit-memos/getdebitmemo","openApiOperationId":"getDebitMemo","summary":"Returns a debit memo from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The debit memo was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DebitMemo"}},"schemaId":"components/schemas/DebitMemo","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The debit memo could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve debit memo based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1debitMemos~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DebitMemo","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DebitMemo"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/debit-memos/getdebitmemo"}],"panels":[]}]},"httpPath":"/debitMemos/{tenantId}/{id}"},{"label":"Partially updates a debit memo with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/debit-memos/patchdebitmemo","routeSlug":"/apis/collect/collect-v1/debit-memos/patchdebitmemo","metadata":{"seo":{"title":"Partially updates a debit memo with the specified ID.","description":"This method will patch an existing debit memo with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchDebitMemo","name":"Partially updates a debit memo with the specified ID.","isWebhook":false,"pointer":"/paths/~1debitMemos~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a debit memo with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing debit memo with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the debit memo to patch.","required":true}],"pointer":"/paths/~1debitMemos~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"schemaId":"schema_412","pointer":"/paths/~1debitMemos~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/debitMemos/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_412"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/debitMemos/{tenantId}/{id}","href":"debit-memos/patchdebitmemo","openApiOperationId":"patchDebitMemo","summary":"Partially updates a debit memo with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"schema_412","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The debit memo was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DebitMemo"}},"schemaId":"components/schemas/DebitMemo","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The debit memo could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The debit memo could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve debit memo based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1debitMemos~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DebitMemo","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DebitMemo"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/debit-memos/patchdebitmemo"}],"panels":[]}]},"httpPath":"/debitMemos/{tenantId}/{id}"},{"label":"Updates a debit memo with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/debit-memos/updatedebitmemo","routeSlug":"/apis/collect/collect-v1/debit-memos/updatedebitmemo","metadata":{"seo":{"title":"Updates a debit memo with the specified ID.","description":"This method will update an existing debit memo with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateDebitMemo","name":"Updates a debit memo with the specified ID.","isWebhook":false,"pointer":"/paths/~1debitMemos~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a debit memo with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing debit memo with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the debit memo to update.","required":true}],"pointer":"/paths/~1debitMemos~1{tenantId}~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/DebitMemo"}},"schemaId":"components/schemas/DebitMemo","pointer":"/paths/~1debitMemos~1{tenantId}~1{id}/put/requestBody","description":"The updated debit memo that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/debitMemos/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DebitMemo"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/debitMemos/{tenantId}/{id}","href":"debit-memos/updatedebitmemo","openApiOperationId":"updateDebitMemo","summary":"Updates a debit memo with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/DebitMemo","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DebitMemo"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The debit memo was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DebitMemo"}},"schemaId":"components/schemas/DebitMemo","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The debit memo supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The debit memo could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The debit memo could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve debit memo based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1debitMemos~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DebitMemo","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DebitMemo"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/debit-memos/updatedebitmemo"}],"panels":[]}]},"httpPath":"/debitMemos/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Debit Memos"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Debit Memos","showPageActions":true},{"nodeType":"markdoc","content":"Debit Memos"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/debitMemos/warmUpStepFunctions","summary":"Initiates workflow to warm up inventory transactions","prefix":{"name":"post","color":"post"},"badges":[],"link":"/debit-memos/warmupstepfunctions","deprecated":false},{"title":"/debitMemos/{tenantId}","summary":"Gets all of the debit memos in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/debit-memos/listdebitmemos","deprecated":false},{"title":"/debitMemos/{tenantId}","summary":"Processes a new debit memo","prefix":{"name":"post","color":"post"},"badges":[],"link":"/debit-memos/processdebitmemo","deprecated":false},{"title":"/debitMemos/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/debit-memos/executebatchoperations","deprecated":false},{"title":"/debitMemos/{tenantId}/batch/{batch_id}","summary":"Returns a list of records with the specified batch_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/debit-memos/listmemosbybatchid","deprecated":false},{"title":"/debitMemos/{tenantId}/search","summary":"Searches for debit memos using predefined parameters","prefix":{"name":"post","color":"post"},"badges":[],"link":"/debit-memos/searchfordebitmemos","deprecated":false},{"title":"/debitMemos/{tenantId}/sync","summary":"Creates a new debit that doesn't already exist","prefix":{"name":"post","color":"post"},"badges":[],"link":"/debit-memos/processdebitmemosync","deprecated":false},{"title":"/debitMemos/{tenantId}/{id}","summary":"Returns a debit memo from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/debit-memos/getdebitmemo","deprecated":false},{"title":"/debitMemos/{tenantId}/{id}","summary":"Partially updates a debit memo with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/debit-memos/patchdebitmemo","deprecated":false},{"title":"/debitMemos/{tenantId}/{id}","summary":"Updates a debit memo with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/debit-memos/updatedebitmemo","deprecated":false}]}]}]}]}},{"type":"group","label":"Departments","link":"/apis/collect/collect-v1/departments","routeSlug":"/apis/collect/collect-v1/departments","items":[{"label":"Gets all of the departments in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/departments/listdepartments","routeSlug":"/apis/collect/collect-v1/departments/listdepartments","metadata":{"seo":{"title":"Gets all of the departments in the system.","description":"This method will scan all departments and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listDepartments","name":"Gets all of the departments in the system.","isWebhook":false,"pointer":"/paths/~1departments~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the departments in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all departments and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1departments~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1departments~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/departments/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/departments/{tenantId}","href":"departments/listdepartments","openApiOperationId":"listDepartments","summary":"Gets all of the departments in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The departmentswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_431"}},"schemaId":"schema_431","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1departments~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_431","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_431"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/departments/listdepartments"}],"panels":[]}]},"httpPath":"/departments/{tenantId}"},{"label":"Creates a new department record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/departments/createdepartment","routeSlug":"/apis/collect/collect-v1/departments/createdepartment","metadata":{"seo":{"title":"Creates a new department record that does not already exist.","description":"This method will auto-generate an ID and create a new department. If an ID is specified for the department, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createDepartment","name":"Creates a new department record that does not already exist.","isWebhook":false,"pointer":"/paths/~1departments~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new department record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new department. If an ID is specified for the department, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1departments~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Department"}},"schemaId":"components/schemas/Department","pointer":"/paths/~1departments~1{tenantId}/post/requestBody","description":"The department that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/departments/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Department"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/departments/{tenantId}","href":"departments/createdepartment","openApiOperationId":"createDepartment","summary":"Creates a new department record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Department","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Department"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The department was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Department"}},"schemaId":"components/schemas/Department","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The department you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The department could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add department based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1departments~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Department","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Department"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/departments/createdepartment"}],"panels":[]}]},"httpPath":"/departments/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/departments/executebatchoperations","routeSlug":"/apis/collect/collect-v1/departments/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1departments~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1departments~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1departments~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/departments/{tenantId}/batch","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/departments/{tenantId}/batch","href":"departments/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The department could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve department based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1departments~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/departments/executebatchoperations"}],"panels":[]}]},"httpPath":"/departments/{tenantId}/batch"},{"label":"Returns a department from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/departments/deletedepartment","routeSlug":"/apis/collect/collect-v1/departments/deletedepartment","metadata":{"seo":{"title":"Returns a department from the system by its ID.","description":"This method will delete a department with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteDepartment","name":"Returns a department from the system by its ID.","isWebhook":false,"pointer":"/paths/~1departments~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a department from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a department with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the department to delete.","required":true}],"pointer":"/paths/~1departments~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/departments/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/departments/{tenantId}/{id}","href":"departments/deletedepartment","openApiOperationId":"deleteDepartment","summary":"Returns a department from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The department was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}},"schemaId":"schema_409","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The department could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The department could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to delete department based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1departments~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_409","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/departments/deletedepartment"}],"panels":[]}]},"httpPath":"/departments/{tenantId}/{id}"},{"label":"Returns a department from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/departments/getdepartment","routeSlug":"/apis/collect/collect-v1/departments/getdepartment","metadata":{"seo":{"title":"Returns a department from the system by its ID.","description":"This method will look up a department by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDepartment","name":"Returns a department from the system by its ID.","isWebhook":false,"pointer":"/paths/~1departments~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a department from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a department by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the department to return.","required":true}],"pointer":"/paths/~1departments~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_409","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1departments~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/departments/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/departments/{tenantId}/{id}","href":"departments/getdepartment","openApiOperationId":"getDepartment","summary":"Returns a department from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The department was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Department"}},"schemaId":"components/schemas/Department","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The department could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve department based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1departments~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Department","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Department"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/departments/getdepartment"}],"panels":[]}]},"httpPath":"/departments/{tenantId}/{id}"},{"label":"Partially updates a department with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/departments/patchdepartment","routeSlug":"/apis/collect/collect-v1/departments/patchdepartment","metadata":{"seo":{"title":"Partially updates a department with the specified ID.","description":"This method will patch an existing department with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchDepartment","name":"Partially updates a department with the specified ID.","isWebhook":false,"pointer":"/paths/~1departments~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a department with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing department with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the department to patch.","required":true}],"pointer":"/paths/~1departments~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"schemaId":"schema_412","pointer":"/paths/~1departments~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/departments/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_412"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/departments/{tenantId}/{id}","href":"departments/patchdepartment","openApiOperationId":"patchDepartment","summary":"Partially updates a department with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"schema_412","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The department was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Department"}},"schemaId":"components/schemas/Department","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The department could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The department could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve department based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1departments~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Department","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Department"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/departments/patchdepartment"}],"panels":[]}]},"httpPath":"/departments/{tenantId}/{id}"},{"label":"Updates a department with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/departments/updatedepartment","routeSlug":"/apis/collect/collect-v1/departments/updatedepartment","metadata":{"seo":{"title":"Updates a department with the specified ID.","description":"This method will update an existing department with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateDepartment","name":"Updates a department with the specified ID.","isWebhook":false,"pointer":"/paths/~1departments~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a department with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing department with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the department to update.","required":true}],"pointer":"/paths/~1departments~1{tenantId}~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/Department"}},"schemaId":"components/schemas/Department","pointer":"/paths/~1departments~1{tenantId}~1{id}/put/requestBody","description":"The updated department that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/departments/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Department"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/departments/{tenantId}/{id}","href":"departments/updatedepartment","openApiOperationId":"updateDepartment","summary":"Updates a department with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Department","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Department"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The department was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Department"}},"schemaId":"components/schemas/Department","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The department supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The department could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The department could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve department based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1departments~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Department","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Department"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/departments/updatedepartment"}],"panels":[]}]},"httpPath":"/departments/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Departments"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Departments","showPageActions":true},{"nodeType":"markdoc","content":"Departments"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/departments/{tenantId}","summary":"Gets all of the departments in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/departments/listdepartments","deprecated":false},{"title":"/departments/{tenantId}","summary":"Creates a new department record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/departments/createdepartment","deprecated":false},{"title":"/departments/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/departments/executebatchoperations","deprecated":false},{"title":"/departments/{tenantId}/{id}","summary":"Returns a department from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/departments/deletedepartment","deprecated":false},{"title":"/departments/{tenantId}/{id}","summary":"Returns a department from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/departments/getdepartment","deprecated":false},{"title":"/departments/{tenantId}/{id}","summary":"Partially updates a department with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/departments/patchdepartment","deprecated":false},{"title":"/departments/{tenantId}/{id}","summary":"Updates a department with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/departments/updatedepartment","deprecated":false}]}]}]}]}},{"type":"group","label":"Donation Products","link":"/apis/collect/collect-v1/donation-products","routeSlug":"/apis/collect/collect-v1/donation-products","items":[{"label":"Gets all of the donation products in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/donation-products/listdonationproducts","routeSlug":"/apis/collect/collect-v1/donation-products/listdonationproducts","metadata":{"seo":{"title":"Gets all of the donation products in the system.","description":"This method will scan all donation products and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listDonationProducts","name":"Gets all of the donation products in the system.","isWebhook":false,"pointer":"/paths/~1donationProducts~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the donation products in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all donation products and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1donationProducts~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1donationProducts~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/donationProducts/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/donationProducts/{tenantId}","href":"donation-products/listdonationproducts","openApiOperationId":"listDonationProducts","summary":"Gets all of the donation products in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The donation productswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_432"}},"schemaId":"schema_432","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1donationProducts~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_432","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_432"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/donation-products/listdonationproducts"}],"panels":[]}]},"httpPath":"/donationProducts/{tenantId}"},{"label":"Creates a new donation product record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/donation-products/createdonationproduct","routeSlug":"/apis/collect/collect-v1/donation-products/createdonationproduct","metadata":{"seo":{"title":"Creates a new donation product record that does not already exist.","description":"This method will auto-generate an ID and create a new donation product. If an ID is specified for the donation product, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createDonationProduct","name":"Creates a new donation product record that does not already exist.","isWebhook":false,"pointer":"/paths/~1donationProducts~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new donation product record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new donation product. If an ID is specified for the donation product, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1donationProducts~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DonationProduct"}},"schemaId":"components/schemas/DonationProduct","pointer":"/paths/~1donationProducts~1{tenantId}/post/requestBody","description":"The donation product that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/donationProducts/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DonationProduct"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/donationProducts/{tenantId}","href":"donation-products/createdonationproduct","openApiOperationId":"createDonationProduct","summary":"Creates a new donation product record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/DonationProduct","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DonationProduct"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The donation product was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DonationProduct"}},"schemaId":"components/schemas/DonationProduct","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The donation product you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The donation product could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add donation product based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1donationProducts~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DonationProduct","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DonationProduct"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/donation-products/createdonationproduct"}],"panels":[]}]},"httpPath":"/donationProducts/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/donation-products/executebatchoperations","routeSlug":"/apis/collect/collect-v1/donation-products/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1donationProducts~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1donationProducts~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1donationProducts~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/donationProducts/{tenantId}/batch","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/donationProducts/{tenantId}/batch","href":"donation-products/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The donation product could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve donation product based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1donationProducts~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/donation-products/executebatchoperations"}],"panels":[]}]},"httpPath":"/donationProducts/{tenantId}/batch"},{"label":"Returns a donation product from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/donation-products/deletedonationproduct","routeSlug":"/apis/collect/collect-v1/donation-products/deletedonationproduct","metadata":{"seo":{"title":"Returns a donation product from the system by its ID.","description":"This method will delete a donation product with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteDonationProduct","name":"Returns a donation product from the system by its ID.","isWebhook":false,"pointer":"/paths/~1donationProducts~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a donation product from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a donation product with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the donation product to delete.","required":true}],"pointer":"/paths/~1donationProducts~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/donationProducts/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/donationProducts/{tenantId}/{id}","href":"donation-products/deletedonationproduct","openApiOperationId":"deleteDonationProduct","summary":"Returns a donation product from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The donation product was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}},"schemaId":"schema_409","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The donation product could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The donation product could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to delete donation product based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1donationProducts~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_409","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/donation-products/deletedonationproduct"}],"panels":[]}]},"httpPath":"/donationProducts/{tenantId}/{id}"},{"label":"Returns a donation product from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/donation-products/getdonationproduct","routeSlug":"/apis/collect/collect-v1/donation-products/getdonationproduct","metadata":{"seo":{"title":"Returns a donation product from the system by its ID.","description":"This method will look up a donation product by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDonationProduct","name":"Returns a donation product from the system by its ID.","isWebhook":false,"pointer":"/paths/~1donationProducts~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a donation product from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a donation product by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the donation product to return.","required":true}],"pointer":"/paths/~1donationProducts~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_409","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1donationProducts~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/donationProducts/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/donationProducts/{tenantId}/{id}","href":"donation-products/getdonationproduct","openApiOperationId":"getDonationProduct","summary":"Returns a donation product from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The donation product was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DonationProduct"}},"schemaId":"components/schemas/DonationProduct","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The donation product could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve donation product based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1donationProducts~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DonationProduct","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DonationProduct"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/donation-products/getdonationproduct"}],"panels":[]}]},"httpPath":"/donationProducts/{tenantId}/{id}"},{"label":"Partially updates a donation product with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/donation-products/patchdonationproduct","routeSlug":"/apis/collect/collect-v1/donation-products/patchdonationproduct","metadata":{"seo":{"title":"Partially updates a donation product with the specified ID.","description":"This method will patch an existing donation product with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchDonationProduct","name":"Partially updates a donation product with the specified ID.","isWebhook":false,"pointer":"/paths/~1donationProducts~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a donation product with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing donation product with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the donation product to patch.","required":true}],"pointer":"/paths/~1donationProducts~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"schemaId":"schema_412","pointer":"/paths/~1donationProducts~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/donationProducts/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_412"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/donationProducts/{tenantId}/{id}","href":"donation-products/patchdonationproduct","openApiOperationId":"patchDonationProduct","summary":"Partially updates a donation product with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"schema_412","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The donation product was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DonationProduct"}},"schemaId":"components/schemas/DonationProduct","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The donation product could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The donation product could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve donation product based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1donationProducts~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DonationProduct","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DonationProduct"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/donation-products/patchdonationproduct"}],"panels":[]}]},"httpPath":"/donationProducts/{tenantId}/{id}"},{"label":"Updates a donation product with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/donation-products/updatedonationproduct","routeSlug":"/apis/collect/collect-v1/donation-products/updatedonationproduct","metadata":{"seo":{"title":"Updates a donation product with the specified ID.","description":"This method will update an existing donation product with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateDonationProduct","name":"Updates a donation product with the specified ID.","isWebhook":false,"pointer":"/paths/~1donationProducts~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a donation product with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing donation product with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the donation product to update.","required":true}],"pointer":"/paths/~1donationProducts~1{tenantId}~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/DonationProduct"}},"schemaId":"components/schemas/DonationProduct","pointer":"/paths/~1donationProducts~1{tenantId}~1{id}/put/requestBody","description":"The updated donation product that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/donationProducts/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DonationProduct"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/donationProducts/{tenantId}/{id}","href":"donation-products/updatedonationproduct","openApiOperationId":"updateDonationProduct","summary":"Updates a donation product with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/DonationProduct","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DonationProduct"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The donation product was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DonationProduct"}},"schemaId":"components/schemas/DonationProduct","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The donation product supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The donation product could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The donation product could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve donation product based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1donationProducts~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DonationProduct","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DonationProduct"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/donation-products/updatedonationproduct"}],"panels":[]}]},"httpPath":"/donationProducts/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Donation Products"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Donation Products","showPageActions":true},{"nodeType":"markdoc","content":"Donation Products"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/donationProducts/{tenantId}","summary":"Gets all of the donation products in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/donation-products/listdonationproducts","deprecated":false},{"title":"/donationProducts/{tenantId}","summary":"Creates a new donation product record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/donation-products/createdonationproduct","deprecated":false},{"title":"/donationProducts/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/donation-products/executebatchoperations","deprecated":false},{"title":"/donationProducts/{tenantId}/{id}","summary":"Returns a donation product from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/donation-products/deletedonationproduct","deprecated":false},{"title":"/donationProducts/{tenantId}/{id}","summary":"Returns a donation product from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/donation-products/getdonationproduct","deprecated":false},{"title":"/donationProducts/{tenantId}/{id}","summary":"Partially updates a donation product with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/donation-products/patchdonationproduct","deprecated":false},{"title":"/donationProducts/{tenantId}/{id}","summary":"Updates a donation product with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/donation-products/updatedonationproduct","deprecated":false}]}]}]}]}},{"type":"group","label":"Exchange Rates","link":"/apis/collect/collect-v1/exchange-rates","routeSlug":"/apis/collect/collect-v1/exchange-rates","items":[{"label":"Gets all of the exchange rates in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/exchange-rates/listexchangerates","routeSlug":"/apis/collect/collect-v1/exchange-rates/listexchangerates","metadata":{"seo":{"title":"Gets all of the exchange rates in the system.","description":"This method will scan all exchange rates and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listExchangeRates","name":"Gets all of the exchange rates in the system.","isWebhook":false,"pointer":"/paths/~1exchangeRates~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the exchange rates in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all exchange rates and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1exchangeRates~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1exchangeRates~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/exchangeRates/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/exchangeRates/{tenantId}","href":"exchange-rates/listexchangerates","openApiOperationId":"listExchangeRates","summary":"Gets all of the exchange rates in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The exchange rateswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_433"}},"schemaId":"schema_433","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1exchangeRates~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_433","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_433"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exchange-rates/listexchangerates"}],"panels":[]}]},"httpPath":"/exchangeRates/{tenantId}"},{"label":"Creates a new exchange rate record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/exchange-rates/createexchangerate","routeSlug":"/apis/collect/collect-v1/exchange-rates/createexchangerate","metadata":{"seo":{"title":"Creates a new exchange rate record that does not already exist.","description":"This method will auto-generate an ID and create a new exchange rate. If an ID is specified for the exchange rate, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createExchangeRate","name":"Creates a new exchange rate record that does not already exist.","isWebhook":false,"pointer":"/paths/~1exchangeRates~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new exchange rate record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new exchange rate. If an ID is specified for the exchange rate, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1exchangeRates~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExchangeRate"}},"schemaId":"components/schemas/ExchangeRate","pointer":"/paths/~1exchangeRates~1{tenantId}/post/requestBody","description":"The exchange rate that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/exchangeRates/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ExchangeRate"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/exchangeRates/{tenantId}","href":"exchange-rates/createexchangerate","openApiOperationId":"createExchangeRate","summary":"Creates a new exchange rate record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ExchangeRate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExchangeRate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The exchange rate was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExchangeRate"}},"schemaId":"components/schemas/ExchangeRate","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The exchange rate you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The exchange rate could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add exchange rate based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1exchangeRates~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExchangeRate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExchangeRate"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exchange-rates/createexchangerate"}],"panels":[]}]},"httpPath":"/exchangeRates/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/exchange-rates/executebatchoperations","routeSlug":"/apis/collect/collect-v1/exchange-rates/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1exchangeRates~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1exchangeRates~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1exchangeRates~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/exchangeRates/{tenantId}/batch","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/exchangeRates/{tenantId}/batch","href":"exchange-rates/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The exchange rate could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve exchange rate based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1exchangeRates~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exchange-rates/executebatchoperations"}],"panels":[]}]},"httpPath":"/exchangeRates/{tenantId}/batch"},{"label":"Returns a exchange rate from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/exchange-rates/deleteexchangerate","routeSlug":"/apis/collect/collect-v1/exchange-rates/deleteexchangerate","metadata":{"seo":{"title":"Returns a exchange rate from the system by its ID.","description":"This method will delete a exchange rate with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteExchangeRate","name":"Returns a exchange rate from the system by its ID.","isWebhook":false,"pointer":"/paths/~1exchangeRates~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a exchange rate from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a exchange rate with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the exchange rate to delete.","required":true}],"pointer":"/paths/~1exchangeRates~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/exchangeRates/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/exchangeRates/{tenantId}/{id}","href":"exchange-rates/deleteexchangerate","openApiOperationId":"deleteExchangeRate","summary":"Returns a exchange rate from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The exchange rate was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}},"schemaId":"schema_409","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The exchange rate could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The exchange rate could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to delete exchange rate based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1exchangeRates~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_409","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exchange-rates/deleteexchangerate"}],"panels":[]}]},"httpPath":"/exchangeRates/{tenantId}/{id}"},{"label":"Returns a exchange rate from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/exchange-rates/getexchangerate","routeSlug":"/apis/collect/collect-v1/exchange-rates/getexchangerate","metadata":{"seo":{"title":"Returns a exchange rate from the system by its ID.","description":"This method will look up a exchange rate by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getExchangeRate","name":"Returns a exchange rate from the system by its ID.","isWebhook":false,"pointer":"/paths/~1exchangeRates~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a exchange rate from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a exchange rate by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the exchange rate to return.","required":true}],"pointer":"/paths/~1exchangeRates~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_409","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1exchangeRates~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/exchangeRates/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/exchangeRates/{tenantId}/{id}","href":"exchange-rates/getexchangerate","openApiOperationId":"getExchangeRate","summary":"Returns a exchange rate from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The exchange rate was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExchangeRate"}},"schemaId":"components/schemas/ExchangeRate","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The exchange rate could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve exchange rate based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1exchangeRates~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExchangeRate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExchangeRate"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exchange-rates/getexchangerate"}],"panels":[]}]},"httpPath":"/exchangeRates/{tenantId}/{id}"},{"label":"Partially updates a exchange rate with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/exchange-rates/patchexchangerate","routeSlug":"/apis/collect/collect-v1/exchange-rates/patchexchangerate","metadata":{"seo":{"title":"Partially updates a exchange rate with the specified ID.","description":"This method will patch an existing exchange rate with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchExchangeRate","name":"Partially updates a exchange rate with the specified ID.","isWebhook":false,"pointer":"/paths/~1exchangeRates~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a exchange rate with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing exchange rate with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the exchange rate to patch.","required":true}],"pointer":"/paths/~1exchangeRates~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"schemaId":"schema_412","pointer":"/paths/~1exchangeRates~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/exchangeRates/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_412"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/exchangeRates/{tenantId}/{id}","href":"exchange-rates/patchexchangerate","openApiOperationId":"patchExchangeRate","summary":"Partially updates a exchange rate with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"schema_412","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The exchange rate was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExchangeRate"}},"schemaId":"components/schemas/ExchangeRate","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The exchange rate could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The exchange rate could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve exchange rate based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1exchangeRates~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExchangeRate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExchangeRate"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exchange-rates/patchexchangerate"}],"panels":[]}]},"httpPath":"/exchangeRates/{tenantId}/{id}"},{"label":"Updates a exchange rate with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/exchange-rates/updateexchangerate","routeSlug":"/apis/collect/collect-v1/exchange-rates/updateexchangerate","metadata":{"seo":{"title":"Updates a exchange rate with the specified ID.","description":"This method will update an existing exchange rate with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateExchangeRate","name":"Updates a exchange rate with the specified ID.","isWebhook":false,"pointer":"/paths/~1exchangeRates~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a exchange rate with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing exchange rate with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the exchange rate to update.","required":true}],"pointer":"/paths/~1exchangeRates~1{tenantId}~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/ExchangeRate"}},"schemaId":"components/schemas/ExchangeRate","pointer":"/paths/~1exchangeRates~1{tenantId}~1{id}/put/requestBody","description":"The updated exchange rate that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/exchangeRates/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ExchangeRate"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/exchangeRates/{tenantId}/{id}","href":"exchange-rates/updateexchangerate","openApiOperationId":"updateExchangeRate","summary":"Updates a exchange rate with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ExchangeRate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExchangeRate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The exchange rate was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExchangeRate"}},"schemaId":"components/schemas/ExchangeRate","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The exchange rate supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The exchange rate could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The exchange rate could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve exchange rate based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1exchangeRates~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExchangeRate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExchangeRate"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/exchange-rates/updateexchangerate"}],"panels":[]}]},"httpPath":"/exchangeRates/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Exchange Rates"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Exchange Rates","showPageActions":true},{"nodeType":"markdoc","content":"Exchange Rates"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/exchangeRates/{tenantId}","summary":"Gets all of the exchange rates in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/exchange-rates/listexchangerates","deprecated":false},{"title":"/exchangeRates/{tenantId}","summary":"Creates a new exchange rate record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/exchange-rates/createexchangerate","deprecated":false},{"title":"/exchangeRates/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/exchange-rates/executebatchoperations","deprecated":false},{"title":"/exchangeRates/{tenantId}/{id}","summary":"Returns a exchange rate from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/exchange-rates/deleteexchangerate","deprecated":false},{"title":"/exchangeRates/{tenantId}/{id}","summary":"Returns a exchange rate from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/exchange-rates/getexchangerate","deprecated":false},{"title":"/exchangeRates/{tenantId}/{id}","summary":"Partially updates a exchange rate with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/exchange-rates/patchexchangerate","deprecated":false},{"title":"/exchangeRates/{tenantId}/{id}","summary":"Updates a exchange rate with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/exchange-rates/updateexchangerate","deprecated":false}]}]}]}]}},{"type":"group","label":"External Payments","link":"/apis/collect/collect-v1/external-payments","routeSlug":"/apis/collect/collect-v1/external-payments","items":[{"label":"Creates a new external payment record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/external-payments/createexternalpayment","routeSlug":"/apis/collect/collect-v1/external-payments/createexternalpayment","metadata":{"seo":{"title":"Creates a new external payment record that does not already exist.","description":"This method will auto-generate an ID and create a new external payment. If an ID is specified for the external payment, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createExternalPayment","name":"Creates a new external payment record that does not already exist.","isWebhook":false,"pointer":"/paths/~1externalPayments~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new external payment record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new external payment. If an ID is specified for the external payment, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1externalPayments~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExternalPayment"}},"schemaId":"components/schemas/ExternalPayment","pointer":"/paths/~1externalPayments~1{tenantId}/post/requestBody","description":"The external payment that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/externalPayments/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ExternalPayment"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/externalPayments/{tenantId}","href":"external-payments/createexternalpayment","openApiOperationId":"createExternalPayment","summary":"Creates a new external payment record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ExternalPayment","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExternalPayment"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The external payment was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExternalPayment"}},"schemaId":"components/schemas/ExternalPayment","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The external payment you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The external payment could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add external payment based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1externalPayments~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExternalPayment","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExternalPayment"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/external-payments/createexternalpayment"}],"panels":[]}]},"httpPath":"/externalPayments/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/external-payments/executebatchoperations","routeSlug":"/apis/collect/collect-v1/external-payments/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1externalPayments~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1externalPayments~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1externalPayments~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/externalPayments/{tenantId}/batch","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/externalPayments/{tenantId}/batch","href":"external-payments/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The external payment could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve external payment based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1externalPayments~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/external-payments/executebatchoperations"}],"panels":[]}]},"httpPath":"/externalPayments/{tenantId}/batch"},{"label":"Returns a list of records with the specified contact_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/external-payments/listpaymentsbycontactid","routeSlug":"/apis/collect/collect-v1/external-payments/listpaymentsbycontactid","metadata":{"seo":{"title":"Returns a list of records with the specified contact_id","description":"Returns a list of records with the specified contact_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listPaymentsByContactId","name":"Returns a list of records with the specified contact_id","isWebhook":false,"pointer":"/paths/~1externalPayments~1{tenantId}~1contact~1{contact_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified contact_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":"Returns a list of records with the specified contact_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The tenant","required":true},{"name":"contact_id","in":"path","schemaId":"schema_409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contact_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1externalPayments~1{tenantId}~1contact~1{contact_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1externalPayments~1{tenantId}~1contact~1{contact_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/externalPayments/{tenantId}/contact/{contact_id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"contact_id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/externalPayments/{tenantId}/contact/{contact_id}","href":"external-payments/listpaymentsbycontactid","openApiOperationId":"listPaymentsByContactId","summary":"Returns a list of records with the specified contact_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListExternalPaymentsResponse"}},"schemaId":"components/schemas/ListExternalPaymentsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1externalPayments~1{tenantId}~1contact~1{contact_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListExternalPaymentsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListExternalPaymentsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/external-payments/listpaymentsbycontactid"}],"panels":[]}]},"httpPath":"/externalPayments/{tenantId}/contact/{contact_id}"},{"label":"Returns a list of records with the specified organization_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/external-payments/listpaymentsbyorganizationid","routeSlug":"/apis/collect/collect-v1/external-payments/listpaymentsbyorganizationid","metadata":{"seo":{"title":"Returns a list of records with the specified organization_id","description":"Returns a list of records with the specified organization_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listPaymentsByOrganizationId","name":"Returns a list of records with the specified organization_id","isWebhook":false,"pointer":"/paths/~1externalPayments~1{tenantId}~1organization~1{organization_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified organization_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":"Returns a list of records with the specified organization_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The tenant","required":true},{"name":"organization_id","in":"path","schemaId":"schema_409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The organization_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1externalPayments~1{tenantId}~1organization~1{organization_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1externalPayments~1{tenantId}~1organization~1{organization_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/externalPayments/{tenantId}/organization/{organization_id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"organization_id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/externalPayments/{tenantId}/organization/{organization_id}","href":"external-payments/listpaymentsbyorganizationid","openApiOperationId":"listPaymentsByOrganizationId","summary":"Returns a list of records with the specified organization_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListExternalPaymentsResponse"}},"schemaId":"components/schemas/ListExternalPaymentsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1externalPayments~1{tenantId}~1organization~1{organization_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListExternalPaymentsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListExternalPaymentsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/external-payments/listpaymentsbyorganizationid"}],"panels":[]}]},"httpPath":"/externalPayments/{tenantId}/organization/{organization_id}"},{"label":"Returns a external payment from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/external-payments/deleteexternalpayment","routeSlug":"/apis/collect/collect-v1/external-payments/deleteexternalpayment","metadata":{"seo":{"title":"Returns a external payment from the system by its ID.","description":"This method will delete a external payment with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteExternalPayment","name":"Returns a external payment from the system by its ID.","isWebhook":false,"pointer":"/paths/~1externalPayments~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a external payment from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a external payment with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the external payment to delete.","required":true}],"pointer":"/paths/~1externalPayments~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/externalPayments/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/externalPayments/{tenantId}/{id}","href":"external-payments/deleteexternalpayment","openApiOperationId":"deleteExternalPayment","summary":"Returns a external payment from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The external payment was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}},"schemaId":"schema_409","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The external payment could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The external payment could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to delete external payment based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1externalPayments~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_409","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/external-payments/deleteexternalpayment"}],"panels":[]}]},"httpPath":"/externalPayments/{tenantId}/{id}"},{"label":"Returns a external payment from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/external-payments/getexternalpayment","routeSlug":"/apis/collect/collect-v1/external-payments/getexternalpayment","metadata":{"seo":{"title":"Returns a external payment from the system by its ID.","description":"This method will look up a external payment by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getExternalPayment","name":"Returns a external payment from the system by its ID.","isWebhook":false,"pointer":"/paths/~1externalPayments~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a external payment from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a external payment by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the external payment to return.","required":true}],"pointer":"/paths/~1externalPayments~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_409","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1externalPayments~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/externalPayments/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/externalPayments/{tenantId}/{id}","href":"external-payments/getexternalpayment","openApiOperationId":"getExternalPayment","summary":"Returns a external payment from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The external payment was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExternalPayment"}},"schemaId":"components/schemas/ExternalPayment","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The external payment could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve external payment based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1externalPayments~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExternalPayment","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExternalPayment"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/external-payments/getexternalpayment"}],"panels":[]}]},"httpPath":"/externalPayments/{tenantId}/{id}"},{"label":"Partially updates a external payment with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/external-payments/patchexternalpayment","routeSlug":"/apis/collect/collect-v1/external-payments/patchexternalpayment","metadata":{"seo":{"title":"Partially updates a external payment with the specified ID.","description":"This method will patch an existing external payment with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchExternalPayment","name":"Partially updates a external payment with the specified ID.","isWebhook":false,"pointer":"/paths/~1externalPayments~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a external payment with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing external payment with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the external payment to patch.","required":true}],"pointer":"/paths/~1externalPayments~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"schemaId":"schema_412","pointer":"/paths/~1externalPayments~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/externalPayments/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_412"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/externalPayments/{tenantId}/{id}","href":"external-payments/patchexternalpayment","openApiOperationId":"patchExternalPayment","summary":"Partially updates a external payment with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"schema_412","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The external payment was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExternalPayment"}},"schemaId":"components/schemas/ExternalPayment","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The external payment could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The external payment could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve external payment based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1externalPayments~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExternalPayment","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExternalPayment"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/external-payments/patchexternalpayment"}],"panels":[]}]},"httpPath":"/externalPayments/{tenantId}/{id}"},{"label":"Updates a external payment with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/external-payments/updateexternalpayment","routeSlug":"/apis/collect/collect-v1/external-payments/updateexternalpayment","metadata":{"seo":{"title":"Updates a external payment with the specified ID.","description":"This method will update an existing external payment with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateExternalPayment","name":"Updates a external payment with the specified ID.","isWebhook":false,"pointer":"/paths/~1externalPayments~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a external payment with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing external payment with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the external payment to update.","required":true}],"pointer":"/paths/~1externalPayments~1{tenantId}~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/ExternalPayment"}},"schemaId":"components/schemas/ExternalPayment","pointer":"/paths/~1externalPayments~1{tenantId}~1{id}/put/requestBody","description":"The updated external payment that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/externalPayments/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ExternalPayment"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/externalPayments/{tenantId}/{id}","href":"external-payments/updateexternalpayment","openApiOperationId":"updateExternalPayment","summary":"Updates a external payment with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ExternalPayment","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExternalPayment"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The external payment was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExternalPayment"}},"schemaId":"components/schemas/ExternalPayment","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The external payment supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The external payment could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The external payment could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve external payment based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1externalPayments~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ExternalPayment","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ExternalPayment"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/external-payments/updateexternalpayment"}],"panels":[]}]},"httpPath":"/externalPayments/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"External Payments"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"External Payments","showPageActions":true},{"nodeType":"markdoc","content":"External Payments"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/externalPayments/{tenantId}","summary":"Creates a new external payment record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/external-payments/createexternalpayment","deprecated":false},{"title":"/externalPayments/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/external-payments/executebatchoperations","deprecated":false},{"title":"/externalPayments/{tenantId}/contact/{contact_id}","summary":"Returns a list of records with the specified contact_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/external-payments/listpaymentsbycontactid","deprecated":false},{"title":"/externalPayments/{tenantId}/organization/{organization_id}","summary":"Returns a list of records with the specified organization_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/external-payments/listpaymentsbyorganizationid","deprecated":false},{"title":"/externalPayments/{tenantId}/{id}","summary":"Returns a external payment from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/external-payments/deleteexternalpayment","deprecated":false},{"title":"/externalPayments/{tenantId}/{id}","summary":"Returns a external payment from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/external-payments/getexternalpayment","deprecated":false},{"title":"/externalPayments/{tenantId}/{id}","summary":"Partially updates a external payment with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/external-payments/patchexternalpayment","deprecated":false},{"title":"/externalPayments/{tenantId}/{id}","summary":"Updates a external payment with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/external-payments/updateexternalpayment","deprecated":false}]}]}]}]}},{"type":"group","label":"Fiscal Years","link":"/apis/collect/collect-v1/fiscal-years","routeSlug":"/apis/collect/collect-v1/fiscal-years","items":[{"label":"Gets all of the fiscal years in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/fiscal-years/listfiscalyears","routeSlug":"/apis/collect/collect-v1/fiscal-years/listfiscalyears","metadata":{"seo":{"title":"Gets all of the fiscal years in the system.","description":"This method will scan all fiscal years and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listFiscalYears","name":"Gets all of the fiscal years in the system.","isWebhook":false,"pointer":"/paths/~1fiscalYears~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the fiscal years in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all fiscal years and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1fiscalYears~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1fiscalYears~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/fiscalYears/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/fiscalYears/{tenantId}","href":"fiscal-years/listfiscalyears","openApiOperationId":"listFiscalYears","summary":"Gets all of the fiscal years in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The fiscal yearswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_434"}},"schemaId":"schema_434","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1fiscalYears~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_434","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_434"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fiscal-years/listfiscalyears"}],"panels":[]}]},"httpPath":"/fiscalYears/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/fiscal-years/executebatchoperations","routeSlug":"/apis/collect/collect-v1/fiscal-years/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1fiscalYears~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1fiscalYears~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1fiscalYears~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/fiscalYears/{tenantId}/batch","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/fiscalYears/{tenantId}/batch","href":"fiscal-years/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The fiscal year could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve fiscal year based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1fiscalYears~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fiscal-years/executebatchoperations"}],"panels":[]}]},"httpPath":"/fiscalYears/{tenantId}/batch"},{"label":"Returns a list of records with the specified business_unit_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/fiscal-years/listyearsbybusinessunitid","routeSlug":"/apis/collect/collect-v1/fiscal-years/listyearsbybusinessunitid","metadata":{"seo":{"title":"Returns a list of records with the specified business_unit_id","description":"Returns a list of records with the specified business_unit_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listYearsByBusinessUnitId","name":"Returns a list of records with the specified business_unit_id","isWebhook":false,"pointer":"/paths/~1fiscalYears~1{tenantId}~1businessUnit~1{business_unit_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified business_unit_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":"Returns a list of records with the specified business_unit_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The tenant","required":true},{"name":"business_unit_id","in":"path","schemaId":"schema_409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The business_unit_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1fiscalYears~1{tenantId}~1businessUnit~1{business_unit_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned"}],"pointer":"/paths/~1fiscalYears~1{tenantId}~1businessUnit~1{business_unit_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/fiscalYears/{tenantId}/businessUnit/{business_unit_id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"business_unit_id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/fiscalYears/{tenantId}/businessUnit/{business_unit_id}","href":"fiscal-years/listyearsbybusinessunitid","openApiOperationId":"listYearsByBusinessUnitId","summary":"Returns a list of records with the specified business_unit_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_434"}},"schemaId":"schema_434","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1fiscalYears~1{tenantId}~1businessUnit~1{business_unit_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_434","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_434"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fiscal-years/listyearsbybusinessunitid"}],"panels":[]}]},"httpPath":"/fiscalYears/{tenantId}/businessUnit/{business_unit_id}"},{"label":"Creates the next fiscal year for a business unit","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/fiscal-years/generatenewfiscalyear","routeSlug":"/apis/collect/collect-v1/fiscal-years/generatenewfiscalyear","metadata":{"seo":{"title":"Creates the next fiscal year for a business unit","description":"This method will automatically create a fiscal year for a business unit in the future"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"generateNewFiscalYear","name":"Creates the next fiscal year for a business unit","isWebhook":false,"pointer":"/paths/~1fiscalYears~1{tenantId}~1businessUnit~1{business_unit_id}/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates the next fiscal year for a business unit","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will automatically create a fiscal year for a business unit in the future"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed","required":true},{"name":"business_unit_id","in":"path","schemaId":"schema_409","description":"The business unit","required":true}],"pointer":"/paths/~1fiscalYears~1{tenantId}~1businessUnit~1{business_unit_id}/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"numberOfYearsToGenerate","in":"query","schemaId":"schema_409","description":"The number of years to create"}],"pointer":"/paths/~1fiscalYears~1{tenantId}~1businessUnit~1{business_unit_id}/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/fiscalYears/{tenantId}/businessUnit/{business_unit_id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"business_unit_id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"numberOfYearsToGenerate","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/fiscalYears/{tenantId}/businessUnit/{business_unit_id}","href":"fiscal-years/generatenewfiscalyear","openApiOperationId":"generateNewFiscalYear","summary":"Creates the next fiscal year for a business unit"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The fiscal year was saved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_434"}},"schemaId":"schema_434","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The fiscal year record you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The fiscal year could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add fiscal year based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1fiscalYears~1{tenantId}~1businessUnit~1{business_unit_id}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_434","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_434"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fiscal-years/generatenewfiscalyear"}],"panels":[]}]},"httpPath":"/fiscalYears/{tenantId}/businessUnit/{business_unit_id}"},{"label":"Initiates workflow to close a fiscal period","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/fiscal-years/closefiscalperiods","routeSlug":"/apis/collect/collect-v1/fiscal-years/closefiscalperiods","metadata":{"seo":{"title":"Initiates workflow to close a fiscal period","description":"This method will initiate the fiscal period close process"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"closeFiscalPeriods","name":"Initiates workflow to close a fiscal period","isWebhook":false,"pointer":"/paths/~1fiscalYears~1{tenantId}~1close~1{fiscalYearId}~1{fiscalPeriod}/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Initiates workflow to close a fiscal period","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will initiate the fiscal period close process"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed","required":true},{"name":"fiscalYearId","in":"path","schemaId":"schema_409","description":"The id of the fiscal year","required":true},{"name":"fiscalPeriod","in":"path","schemaId":"schema_424","description":"The fiscal period","required":true}],"pointer":"/paths/~1fiscalYears~1{tenantId}~1close~1{fiscalYearId}~1{fiscalPeriod}/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/fiscalYears/{tenantId}/close/{fiscalYearId}/{fiscalPeriod}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"fiscalYearId","in":"path","required":true,"schemaId":"schema_409"},{"name":"fiscalPeriod","in":"path","required":true,"schemaId":"schema_424"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/fiscalYears/{tenantId}/close/{fiscalYearId}/{fiscalPeriod}","href":"fiscal-years/closefiscalperiods","openApiOperationId":"closeFiscalPeriods","summary":"Initiates workflow to close a fiscal period"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"An execution ARN to be used to monitor the fiscal period closing process","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StepFunctionExecutionToken"}},"schemaId":"components/schemas/StepFunctionExecutionToken","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The record you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The record you supplied was not found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add batch based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1fiscalYears~1{tenantId}~1close~1{fiscalYearId}~1{fiscalPeriod}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/StepFunctionExecutionToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StepFunctionExecutionToken"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fiscal-years/closefiscalperiods"}],"panels":[]}]},"httpPath":"/fiscalYears/{tenantId}/close/{fiscalYearId}/{fiscalPeriod}"},{"label":"Gets the current fiscal year and period","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/fiscal-years/getcurrentfiscalperiod","routeSlug":"/apis/collect/collect-v1/fiscal-years/getcurrentfiscalperiod","metadata":{"seo":{"title":"Gets the current fiscal year and period","description":"This method looks at all of the fiscal years and periods and finds the first \"open\" one, which is the current"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCurrentFiscalPeriod","name":"Gets the current fiscal year and period","isWebhook":false,"pointer":"/paths/~1fiscalYears~1{tenantId}~1current~1{businessUnitId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets the current fiscal year and period","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method looks at all of the fiscal years and periods and finds the first \"open\" one, which is the current"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed","required":true},{"name":"businessUnitId","in":"path","schemaId":"schema_409","description":"The id of the business unit being accessed","required":true}],"pointer":"/paths/~1fiscalYears~1{tenantId}~1current~1{businessUnitId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/fiscalYears/{tenantId}/current/{businessUnitId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"businessUnitId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/fiscalYears/{tenantId}/current/{businessUnitId}","href":"fiscal-years/getcurrentfiscalperiod","openApiOperationId":"getCurrentFiscalPeriod","summary":"Gets the current fiscal year and period"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The fiscal years were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FiscalYearAndPeriod"}},"schemaId":"components/schemas/FiscalYearAndPeriod","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was invalid","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1fiscalYears~1{tenantId}~1current~1{businessUnitId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/FiscalYearAndPeriod","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FiscalYearAndPeriod"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fiscal-years/getcurrentfiscalperiod"}],"panels":[]}]},"httpPath":"/fiscalYears/{tenantId}/current/{businessUnitId}"},{"label":"Gets the fiscal year and fiscal period for a particular date","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/fiscal-years/getfiscalperiodfordate","routeSlug":"/apis/collect/collect-v1/fiscal-years/getfiscalperiodfordate","metadata":{"seo":{"title":"Gets the fiscal year and fiscal period for a particular date","description":"This method will return a fiscal year and fiscal period object"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getFiscalPeriodForDate","name":"Gets the fiscal year and fiscal period for a particular date","isWebhook":false,"pointer":"/paths/~1fiscalYears~1{tenantId}~1fiscalPeriod~1{businessUnitId}~1{date}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets the fiscal year and fiscal period for a particular date","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will return a fiscal year and fiscal period object"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed","required":true},{"name":"businessUnitId","in":"path","schemaId":"schema_409","description":"The id of the business unit being accessed","required":true},{"name":"date","in":"path","schemaId":"schema_409","description":"The date being looked up","required":true}],"pointer":"/paths/~1fiscalYears~1{tenantId}~1fiscalPeriod~1{businessUnitId}~1{date}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/fiscalYears/{tenantId}/fiscalPeriod/{businessUnitId}/{date}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"businessUnitId","in":"path","required":true,"schemaId":"schema_409"},{"name":"date","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/fiscalYears/{tenantId}/fiscalPeriod/{businessUnitId}/{date}","href":"fiscal-years/getfiscalperiodfordate","openApiOperationId":"getFiscalPeriodForDate","summary":"Gets the fiscal year and fiscal period for a particular date"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The fiscal years were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_435"}},"schemaId":"schema_435","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was invalid","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1fiscalYears~1{tenantId}~1fiscalPeriod~1{businessUnitId}~1{date}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_435","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_435"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fiscal-years/getfiscalperiodfordate"}],"panels":[]}]},"httpPath":"/fiscalYears/{tenantId}/fiscalPeriod/{businessUnitId}/{date}"},{"label":"Initiates workflow to reopen a fiscal period","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/fiscal-years/reopenfiscalperiods","routeSlug":"/apis/collect/collect-v1/fiscal-years/reopenfiscalperiods","metadata":{"seo":{"title":"Initiates workflow to reopen a fiscal period","description":"This method will initiate the fiscal period reopen process"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"reopenFiscalPeriods","name":"Initiates workflow to reopen a fiscal period","isWebhook":false,"pointer":"/paths/~1fiscalYears~1{tenantId}~1reopen~1{fiscalYearId}~1{fiscalPeriod}/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Initiates workflow to reopen a fiscal period","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will initiate the fiscal period reopen process"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed","required":true},{"name":"fiscalYearId","in":"path","schemaId":"schema_409","description":"The id of the fiscal year","required":true},{"name":"fiscalPeriod","in":"path","schemaId":"schema_424","description":"The fiscal period","required":true}],"pointer":"/paths/~1fiscalYears~1{tenantId}~1reopen~1{fiscalYearId}~1{fiscalPeriod}/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/fiscalYears/{tenantId}/reopen/{fiscalYearId}/{fiscalPeriod}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"fiscalYearId","in":"path","required":true,"schemaId":"schema_409"},{"name":"fiscalPeriod","in":"path","required":true,"schemaId":"schema_424"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/fiscalYears/{tenantId}/reopen/{fiscalYearId}/{fiscalPeriod}","href":"fiscal-years/reopenfiscalperiods","openApiOperationId":"reopenFiscalPeriods","summary":"Initiates workflow to reopen a fiscal period"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"An execution ARN to be used to monitor the fiscal period reopening process","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StepFunctionExecutionToken"}},"schemaId":"components/schemas/StepFunctionExecutionToken","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The record you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The record you supplied was not found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add batch based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1fiscalYears~1{tenantId}~1reopen~1{fiscalYearId}~1{fiscalPeriod}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/StepFunctionExecutionToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StepFunctionExecutionToken"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fiscal-years/reopenfiscalperiods"}],"panels":[]}]},"httpPath":"/fiscalYears/{tenantId}/reopen/{fiscalYearId}/{fiscalPeriod}"},{"label":"Returns a fiscal year from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/fiscal-years/deletefiscalyear","routeSlug":"/apis/collect/collect-v1/fiscal-years/deletefiscalyear","metadata":{"seo":{"title":"Returns a fiscal year from the system by its ID.","description":"This method will delete a fiscal year with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteFiscalYear","name":"Returns a fiscal year from the system by its ID.","isWebhook":false,"pointer":"/paths/~1fiscalYears~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a fiscal year from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a fiscal year with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the fiscal year to delete.","required":true}],"pointer":"/paths/~1fiscalYears~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/fiscalYears/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/fiscalYears/{tenantId}/{id}","href":"fiscal-years/deletefiscalyear","openApiOperationId":"deleteFiscalYear","summary":"Returns a fiscal year from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The fiscal year was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}},"schemaId":"schema_409","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The fiscal year could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The fiscal year could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to delete fiscal year based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1fiscalYears~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_409","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fiscal-years/deletefiscalyear"}],"panels":[]}]},"httpPath":"/fiscalYears/{tenantId}/{id}"},{"label":"Returns a fiscal year from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/fiscal-years/getfiscalyear","routeSlug":"/apis/collect/collect-v1/fiscal-years/getfiscalyear","metadata":{"seo":{"title":"Returns a fiscal year from the system by its ID.","description":"This method will look up a fiscal year by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getFiscalYear","name":"Returns a fiscal year from the system by its ID.","isWebhook":false,"pointer":"/paths/~1fiscalYears~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a fiscal year from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a fiscal year by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the fiscal year to return.","required":true}],"pointer":"/paths/~1fiscalYears~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_409","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1fiscalYears~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/fiscalYears/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/fiscalYears/{tenantId}/{id}","href":"fiscal-years/getfiscalyear","openApiOperationId":"getFiscalYear","summary":"Returns a fiscal year from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The fiscal year was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FiscalYear"}},"schemaId":"components/schemas/FiscalYear","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The fiscal year could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve fiscal year based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1fiscalYears~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/FiscalYear","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FiscalYear"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fiscal-years/getfiscalyear"}],"panels":[]}]},"httpPath":"/fiscalYears/{tenantId}/{id}"},{"label":"Partially updates a fiscal year with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/fiscal-years/patchfiscalyear","routeSlug":"/apis/collect/collect-v1/fiscal-years/patchfiscalyear","metadata":{"seo":{"title":"Partially updates a fiscal year with the specified ID.","description":"This method will patch an existing fiscal year with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchFiscalYear","name":"Partially updates a fiscal year with the specified ID.","isWebhook":false,"pointer":"/paths/~1fiscalYears~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a fiscal year with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing fiscal year with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the fiscal year to patch.","required":true}],"pointer":"/paths/~1fiscalYears~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"schemaId":"schema_412","pointer":"/paths/~1fiscalYears~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/fiscalYears/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_412"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/fiscalYears/{tenantId}/{id}","href":"fiscal-years/patchfiscalyear","openApiOperationId":"patchFiscalYear","summary":"Partially updates a fiscal year with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"schema_412","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The fiscal year was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FiscalYear"}},"schemaId":"components/schemas/FiscalYear","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The fiscal year could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The fiscal year could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve fiscal year based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1fiscalYears~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/FiscalYear","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FiscalYear"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fiscal-years/patchfiscalyear"}],"panels":[]}]},"httpPath":"/fiscalYears/{tenantId}/{id}"},{"label":"Updates a fiscal year with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/fiscal-years/updatefiscalyear","routeSlug":"/apis/collect/collect-v1/fiscal-years/updatefiscalyear","metadata":{"seo":{"title":"Updates a fiscal year with the specified ID.","description":"This method will update an existing fiscal year with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateFiscalYear","name":"Updates a fiscal year with the specified ID.","isWebhook":false,"pointer":"/paths/~1fiscalYears~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a fiscal year with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing fiscal year with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the fiscal year to update.","required":true}],"pointer":"/paths/~1fiscalYears~1{tenantId}~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/FiscalYear"}},"schemaId":"components/schemas/FiscalYear","pointer":"/paths/~1fiscalYears~1{tenantId}~1{id}/put/requestBody","description":"The updated fiscal year that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/fiscalYears/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/FiscalYear"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/fiscalYears/{tenantId}/{id}","href":"fiscal-years/updatefiscalyear","openApiOperationId":"updateFiscalYear","summary":"Updates a fiscal year with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/FiscalYear","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/FiscalYear"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The fiscal year was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FiscalYear"}},"schemaId":"components/schemas/FiscalYear","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The fiscal year supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The fiscal year could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The fiscal year could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve fiscal year based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1fiscalYears~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/FiscalYear","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FiscalYear"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fiscal-years/updatefiscalyear"}],"panels":[]}]},"httpPath":"/fiscalYears/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Fiscal Years"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fiscal Years","showPageActions":true},{"nodeType":"markdoc","content":"Fiscal Years"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/fiscalYears/{tenantId}","summary":"Gets all of the fiscal years in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/fiscal-years/listfiscalyears","deprecated":false},{"title":"/fiscalYears/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/fiscal-years/executebatchoperations","deprecated":false},{"title":"/fiscalYears/{tenantId}/businessUnit/{business_unit_id}","summary":"Returns a list of records with the specified business_unit_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/fiscal-years/listyearsbybusinessunitid","deprecated":false},{"title":"/fiscalYears/{tenantId}/businessUnit/{business_unit_id}","summary":"Creates the next fiscal year for a business unit","prefix":{"name":"post","color":"post"},"badges":[],"link":"/fiscal-years/generatenewfiscalyear","deprecated":false},{"title":"/fiscalYears/{tenantId}/close/{fiscalYearId}/{fiscalPeriod}","summary":"Initiates workflow to close a fiscal period","prefix":{"name":"post","color":"post"},"badges":[],"link":"/fiscal-years/closefiscalperiods","deprecated":false},{"title":"/fiscalYears/{tenantId}/current/{businessUnitId}","summary":"Gets the current fiscal year and period","prefix":{"name":"get","color":"get"},"badges":[],"link":"/fiscal-years/getcurrentfiscalperiod","deprecated":false},{"title":"/fiscalYears/{tenantId}/fiscalPeriod/{businessUnitId}/{date}","summary":"Gets the fiscal year and fiscal period for a particular date","prefix":{"name":"get","color":"get"},"badges":[],"link":"/fiscal-years/getfiscalperiodfordate","deprecated":false},{"title":"/fiscalYears/{tenantId}/reopen/{fiscalYearId}/{fiscalPeriod}","summary":"Initiates workflow to reopen a fiscal period","prefix":{"name":"post","color":"post"},"badges":[],"link":"/fiscal-years/reopenfiscalperiods","deprecated":false},{"title":"/fiscalYears/{tenantId}/{id}","summary":"Returns a fiscal year from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/fiscal-years/deletefiscalyear","deprecated":false},{"title":"/fiscalYears/{tenantId}/{id}","summary":"Returns a fiscal year from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/fiscal-years/getfiscalyear","deprecated":false},{"title":"/fiscalYears/{tenantId}/{id}","summary":"Partially updates a fiscal year with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/fiscal-years/patchfiscalyear","deprecated":false},{"title":"/fiscalYears/{tenantId}/{id}","summary":"Updates a fiscal year with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/fiscal-years/updatefiscalyear","deprecated":false}]}]}]}]}},{"type":"group","label":"Gateway Entities","link":"/apis/collect/collect-v1/gateway-entities","routeSlug":"/apis/collect/collect-v1/gateway-entities","items":[{"label":"Returns a gateway entity from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/gateway-entities/getgatewayentity","routeSlug":"/apis/collect/collect-v1/gateway-entities/getgatewayentity","metadata":{"seo":{"title":"Returns a gateway entity from the system by its ID.","description":"This method will look up a gateway entity by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getGatewayEntity","name":"Returns a gateway entity from the system by its ID.","isWebhook":false,"pointer":"/paths/~1gatewayEntities~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a gateway entity from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a gateway entity by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the gateway entity to return.","required":true}],"pointer":"/paths/~1gatewayEntities~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_409","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1gatewayEntities~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/gatewayEntities/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/gatewayEntities/{tenantId}/{id}","href":"gateway-entities/getgatewayentity","openApiOperationId":"getGatewayEntity","summary":"Returns a gateway entity from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The gateway entity was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayEntity"}},"schemaId":"components/schemas/GatewayEntity","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The gateway entity could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve gateway entity based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1gatewayEntities~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GatewayEntity","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayEntity"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/gateway-entities/getgatewayentity"}],"panels":[]}]},"httpPath":"/gatewayEntities/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Gateway Entities"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gateway Entities","showPageActions":true},{"nodeType":"markdoc","content":"Gateway Entities"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/gatewayEntities/{tenantId}/{id}","summary":"Returns a gateway entity from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/gateway-entities/getgatewayentity","deprecated":false}]}]}]}]}},{"type":"group","label":"Gateway Entries","link":"/apis/collect/collect-v1/gateway-entries","routeSlug":"/apis/collect/collect-v1/gateway-entries","items":[{"label":"Returns a gateway entry from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/gateway-entries/getgatewayentry","routeSlug":"/apis/collect/collect-v1/gateway-entries/getgatewayentry","metadata":{"seo":{"title":"Returns a gateway entry from the system by its ID.","description":"This method will look up a gateway entry by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getGatewayEntry","name":"Returns a gateway entry from the system by its ID.","isWebhook":false,"pointer":"/paths/~1gatewayEntries~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a gateway entry from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a gateway entry by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the gateway entry to return.","required":true}],"pointer":"/paths/~1gatewayEntries~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_409","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1gatewayEntries~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/gatewayEntries/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/gatewayEntries/{tenantId}/{id}","href":"gateway-entries/getgatewayentry","openApiOperationId":"getGatewayEntry","summary":"Returns a gateway entry from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The gateway entry was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayEntry"}},"schemaId":"components/schemas/GatewayEntry","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The gateway entry could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve gateway entry based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1gatewayEntries~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GatewayEntry","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayEntry"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/gateway-entries/getgatewayentry"}],"panels":[]}]},"httpPath":"/gatewayEntries/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Gateway Entries"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gateway Entries","showPageActions":true},{"nodeType":"markdoc","content":"Gateway Entries"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/gatewayEntries/{tenantId}/{id}","summary":"Returns a gateway entry from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/gateway-entries/getgatewayentry","deprecated":false}]}]}]}]}},{"type":"group","label":"Gateway Fees","link":"/apis/collect/collect-v1/gateway-fees","routeSlug":"/apis/collect/collect-v1/gateway-fees","items":[{"label":"Returns a gateway fee from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/gateway-fees/getgatewayfee","routeSlug":"/apis/collect/collect-v1/gateway-fees/getgatewayfee","metadata":{"seo":{"title":"Returns a gateway fee from the system by its ID.","description":"This method will look up a gateway fee by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getGatewayFee","name":"Returns a gateway fee from the system by its ID.","isWebhook":false,"pointer":"/paths/~1gatewayFees~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a gateway fee from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a gateway fee by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the gateway fee to return.","required":true}],"pointer":"/paths/~1gatewayFees~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_409","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1gatewayFees~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/gatewayFees/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/gatewayFees/{tenantId}/{id}","href":"gateway-fees/getgatewayfee","openApiOperationId":"getGatewayFee","summary":"Returns a gateway fee from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The gateway fee was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayEntity"}},"schemaId":"components/schemas/GatewayEntity","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The gateway fee could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve gateway fee based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1gatewayFees~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GatewayEntity","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GatewayEntity"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/gateway-fees/getgatewayfee"}],"panels":[]}]},"httpPath":"/gatewayFees/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Gateway Fees"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gateway Fees","showPageActions":true},{"nodeType":"markdoc","content":"Gateway Fees"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/gatewayFees/{tenantId}/{id}","summary":"Returns a gateway fee from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/gateway-fees/getgatewayfee","deprecated":false}]}]}]}]}},{"type":"group","label":"Gl Accounts","link":"/apis/collect/collect-v1/gl-accounts","routeSlug":"/apis/collect/collect-v1/gl-accounts","items":[{"label":"Gets all of the gl accounts in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/gl-accounts/listglaccounts","routeSlug":"/apis/collect/collect-v1/gl-accounts/listglaccounts","metadata":{"seo":{"title":"Gets all of the gl accounts in the system.","description":"This method will scan all gl accounts and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listGlAccounts","name":"Gets all of the gl accounts in the system.","isWebhook":false,"pointer":"/paths/~1glAccounts~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the gl accounts in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all gl accounts and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1glAccounts~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1glAccounts~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/glAccounts/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/glAccounts/{tenantId}","href":"gl-accounts/listglaccounts","openApiOperationId":"listGlAccounts","summary":"Gets all of the gl accounts in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The gl accountswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_436"}},"schemaId":"schema_436","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1glAccounts~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_436","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_436"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/gl-accounts/listglaccounts"}],"panels":[]}]},"httpPath":"/glAccounts/{tenantId}"},{"label":"Creates a new gl account record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/gl-accounts/createglaccount","routeSlug":"/apis/collect/collect-v1/gl-accounts/createglaccount","metadata":{"seo":{"title":"Creates a new gl account record that does not already exist.","description":"This method will auto-generate an ID and create a new gl account. If an ID is specified for the gl account, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createGlAccount","name":"Creates a new gl account record that does not already exist.","isWebhook":false,"pointer":"/paths/~1glAccounts~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new gl account record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new gl account. If an ID is specified for the gl account, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1glAccounts~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GlAccount"}},"schemaId":"components/schemas/GlAccount","pointer":"/paths/~1glAccounts~1{tenantId}/post/requestBody","description":"The gl account that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/glAccounts/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/GlAccount"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/glAccounts/{tenantId}","href":"gl-accounts/createglaccount","openApiOperationId":"createGlAccount","summary":"Creates a new gl account record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/GlAccount","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GlAccount"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The gl account was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GlAccount"}},"schemaId":"components/schemas/GlAccount","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The gl account you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The gl account could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add gl account based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1glAccounts~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GlAccount","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GlAccount"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/gl-accounts/createglaccount"}],"panels":[]}]},"httpPath":"/glAccounts/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/gl-accounts/executebatchoperations","routeSlug":"/apis/collect/collect-v1/gl-accounts/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1glAccounts~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1glAccounts~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1glAccounts~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/glAccounts/{tenantId}/batch","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/glAccounts/{tenantId}/batch","href":"gl-accounts/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The gl account could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve gl account based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1glAccounts~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/gl-accounts/executebatchoperations"}],"panels":[]}]},"httpPath":"/glAccounts/{tenantId}/batch"},{"label":"Returns a gl account from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/gl-accounts/deleteglaccount","routeSlug":"/apis/collect/collect-v1/gl-accounts/deleteglaccount","metadata":{"seo":{"title":"Returns a gl account from the system by its ID.","description":"This method will delete a gl account with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteGlAccount","name":"Returns a gl account from the system by its ID.","isWebhook":false,"pointer":"/paths/~1glAccounts~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a gl account from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a gl account with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the gl account to delete.","required":true}],"pointer":"/paths/~1glAccounts~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/glAccounts/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/glAccounts/{tenantId}/{id}","href":"gl-accounts/deleteglaccount","openApiOperationId":"deleteGlAccount","summary":"Returns a gl account from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The gl account was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}},"schemaId":"schema_409","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The gl account could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The gl account could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to delete gl account based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1glAccounts~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_409","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/gl-accounts/deleteglaccount"}],"panels":[]}]},"httpPath":"/glAccounts/{tenantId}/{id}"},{"label":"Returns a gl account from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/gl-accounts/getglaccount","routeSlug":"/apis/collect/collect-v1/gl-accounts/getglaccount","metadata":{"seo":{"title":"Returns a gl account from the system by its ID.","description":"This method will look up a gl account by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getGlAccount","name":"Returns a gl account from the system by its ID.","isWebhook":false,"pointer":"/paths/~1glAccounts~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a gl account from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a gl account by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the gl account to return.","required":true}],"pointer":"/paths/~1glAccounts~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_409","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1glAccounts~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/glAccounts/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/glAccounts/{tenantId}/{id}","href":"gl-accounts/getglaccount","openApiOperationId":"getGlAccount","summary":"Returns a gl account from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The gl account was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GlAccount"}},"schemaId":"components/schemas/GlAccount","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The gl account could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve gl account based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1glAccounts~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GlAccount","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GlAccount"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/gl-accounts/getglaccount"}],"panels":[]}]},"httpPath":"/glAccounts/{tenantId}/{id}"},{"label":"Partially updates a gl account with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/gl-accounts/patchglaccount","routeSlug":"/apis/collect/collect-v1/gl-accounts/patchglaccount","metadata":{"seo":{"title":"Partially updates a gl account with the specified ID.","description":"This method will patch an existing gl account with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchGlAccount","name":"Partially updates a gl account with the specified ID.","isWebhook":false,"pointer":"/paths/~1glAccounts~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a gl account with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing gl account with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the gl account to patch.","required":true}],"pointer":"/paths/~1glAccounts~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"schemaId":"schema_412","pointer":"/paths/~1glAccounts~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/glAccounts/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_412"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/glAccounts/{tenantId}/{id}","href":"gl-accounts/patchglaccount","openApiOperationId":"patchGlAccount","summary":"Partially updates a gl account with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"schema_412","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The gl account was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GlAccount"}},"schemaId":"components/schemas/GlAccount","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The gl account could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The gl account could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve gl account based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1glAccounts~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GlAccount","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GlAccount"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/gl-accounts/patchglaccount"}],"panels":[]}]},"httpPath":"/glAccounts/{tenantId}/{id}"},{"label":"Updates a gl account with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/gl-accounts/updateglaccount","routeSlug":"/apis/collect/collect-v1/gl-accounts/updateglaccount","metadata":{"seo":{"title":"Updates a gl account with the specified ID.","description":"This method will update an existing gl account with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateGlAccount","name":"Updates a gl account with the specified ID.","isWebhook":false,"pointer":"/paths/~1glAccounts~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a gl account with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing gl account with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the gl account to update.","required":true}],"pointer":"/paths/~1glAccounts~1{tenantId}~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/GlAccount"}},"schemaId":"components/schemas/GlAccount","pointer":"/paths/~1glAccounts~1{tenantId}~1{id}/put/requestBody","description":"The updated gl account that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/glAccounts/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/GlAccount"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/glAccounts/{tenantId}/{id}","href":"gl-accounts/updateglaccount","openApiOperationId":"updateGlAccount","summary":"Updates a gl account with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/GlAccount","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GlAccount"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The gl account was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GlAccount"}},"schemaId":"components/schemas/GlAccount","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The gl account supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The gl account could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The gl account could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve gl account based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1glAccounts~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/GlAccount","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GlAccount"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/gl-accounts/updateglaccount"}],"panels":[]}]},"httpPath":"/glAccounts/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Gl Accounts"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gl Accounts","showPageActions":true},{"nodeType":"markdoc","content":"Gl Accounts"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/glAccounts/{tenantId}","summary":"Gets all of the gl accounts in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/gl-accounts/listglaccounts","deprecated":false},{"title":"/glAccounts/{tenantId}","summary":"Creates a new gl account record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/gl-accounts/createglaccount","deprecated":false},{"title":"/glAccounts/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/gl-accounts/executebatchoperations","deprecated":false},{"title":"/glAccounts/{tenantId}/{id}","summary":"Returns a gl account from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/gl-accounts/deleteglaccount","deprecated":false},{"title":"/glAccounts/{tenantId}/{id}","summary":"Returns a gl account from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/gl-accounts/getglaccount","deprecated":false},{"title":"/glAccounts/{tenantId}/{id}","summary":"Partially updates a gl account with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/gl-accounts/patchglaccount","deprecated":false},{"title":"/glAccounts/{tenantId}/{id}","summary":"Updates a gl account with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/gl-accounts/updateglaccount","deprecated":false}]}]}]}]}},{"type":"group","label":"Installment Plans","link":"/apis/collect/collect-v1/installment-plans","routeSlug":"/apis/collect/collect-v1/installment-plans","items":[{"label":"Gets all of the installment plans in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/installment-plans/listinstallmentplans","routeSlug":"/apis/collect/collect-v1/installment-plans/listinstallmentplans","metadata":{"seo":{"title":"Gets all of the installment plans in the system.","description":"This method will scan all installment plans and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listInstallmentPlans","name":"Gets all of the installment plans in the system.","isWebhook":false,"pointer":"/paths/~1installmentPlans~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the installment plans in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all installment plans and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1installmentPlans~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1installmentPlans~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/installmentPlans/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/installmentPlans/{tenantId}","href":"installment-plans/listinstallmentplans","openApiOperationId":"listInstallmentPlans","summary":"Gets all of the installment plans in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The installment planswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_437"}},"schemaId":"schema_437","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1installmentPlans~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_437","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_437"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/installment-plans/listinstallmentplans"}],"panels":[]}]},"httpPath":"/installmentPlans/{tenantId}"},{"label":"Creates a new installment plan record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/installment-plans/createinstallmentplan","routeSlug":"/apis/collect/collect-v1/installment-plans/createinstallmentplan","metadata":{"seo":{"title":"Creates a new installment plan record that does not already exist.","description":"This method will auto-generate an ID and create a new installment plan. If an ID is specified for the installment plan, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createInstallmentPlan","name":"Creates a new installment plan record that does not already exist.","isWebhook":false,"pointer":"/paths/~1installmentPlans~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new installment plan record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new installment plan. If an ID is specified for the installment plan, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1installmentPlans~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/InstallmentPlan"}},"schemaId":"components/schemas/InstallmentPlan","pointer":"/paths/~1installmentPlans~1{tenantId}/post/requestBody","description":"The installment plan that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/installmentPlans/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/InstallmentPlan"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/installmentPlans/{tenantId}","href":"installment-plans/createinstallmentplan","openApiOperationId":"createInstallmentPlan","summary":"Creates a new installment plan record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/InstallmentPlan","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/InstallmentPlan"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The installment plan was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InstallmentPlan"}},"schemaId":"components/schemas/InstallmentPlan","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The installment plan you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The installment plan could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add installment plan based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1installmentPlans~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/InstallmentPlan","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InstallmentPlan"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/installment-plans/createinstallmentplan"}],"panels":[]}]},"httpPath":"/installmentPlans/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/installment-plans/executebatchoperations","routeSlug":"/apis/collect/collect-v1/installment-plans/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1installmentPlans~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1installmentPlans~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1installmentPlans~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/installmentPlans/{tenantId}/batch","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/installmentPlans/{tenantId}/batch","href":"installment-plans/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The installment plan could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve installment plan based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1installmentPlans~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/installment-plans/executebatchoperations"}],"panels":[]}]},"httpPath":"/installmentPlans/{tenantId}/batch"},{"label":"Returns a installment plan from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/installment-plans/deleteinstallmentplan","routeSlug":"/apis/collect/collect-v1/installment-plans/deleteinstallmentplan","metadata":{"seo":{"title":"Returns a installment plan from the system by its ID.","description":"This method will delete a installment plan with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteInstallmentPlan","name":"Returns a installment plan from the system by its ID.","isWebhook":false,"pointer":"/paths/~1installmentPlans~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a installment plan from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a installment plan with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the installment plan to delete.","required":true}],"pointer":"/paths/~1installmentPlans~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/installmentPlans/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/installmentPlans/{tenantId}/{id}","href":"installment-plans/deleteinstallmentplan","openApiOperationId":"deleteInstallmentPlan","summary":"Returns a installment plan from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The installment plan was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}},"schemaId":"schema_409","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The installment plan could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The installment plan could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to delete installment plan based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1installmentPlans~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_409","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/installment-plans/deleteinstallmentplan"}],"panels":[]}]},"httpPath":"/installmentPlans/{tenantId}/{id}"},{"label":"Returns a installment plan from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/installment-plans/getinstallmentplan","routeSlug":"/apis/collect/collect-v1/installment-plans/getinstallmentplan","metadata":{"seo":{"title":"Returns a installment plan from the system by its ID.","description":"This method will look up a installment plan by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getInstallmentPlan","name":"Returns a installment plan from the system by its ID.","isWebhook":false,"pointer":"/paths/~1installmentPlans~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a installment plan from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a installment plan by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the installment plan to return.","required":true}],"pointer":"/paths/~1installmentPlans~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_409","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1installmentPlans~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/installmentPlans/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/installmentPlans/{tenantId}/{id}","href":"installment-plans/getinstallmentplan","openApiOperationId":"getInstallmentPlan","summary":"Returns a installment plan from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The installment plan was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InstallmentPlan"}},"schemaId":"components/schemas/InstallmentPlan","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The installment plan could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve installment plan based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1installmentPlans~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/InstallmentPlan","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InstallmentPlan"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/installment-plans/getinstallmentplan"}],"panels":[]}]},"httpPath":"/installmentPlans/{tenantId}/{id}"},{"label":"Partially updates a installment plan with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/installment-plans/patchinstallmentplan","routeSlug":"/apis/collect/collect-v1/installment-plans/patchinstallmentplan","metadata":{"seo":{"title":"Partially updates a installment plan with the specified ID.","description":"This method will patch an existing installment plan with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchInstallmentPlan","name":"Partially updates a installment plan with the specified ID.","isWebhook":false,"pointer":"/paths/~1installmentPlans~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a installment plan with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing installment plan with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the installment plan to patch.","required":true}],"pointer":"/paths/~1installmentPlans~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"schemaId":"schema_412","pointer":"/paths/~1installmentPlans~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/installmentPlans/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_412"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/installmentPlans/{tenantId}/{id}","href":"installment-plans/patchinstallmentplan","openApiOperationId":"patchInstallmentPlan","summary":"Partially updates a installment plan with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"schema_412","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The installment plan was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InstallmentPlan"}},"schemaId":"components/schemas/InstallmentPlan","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The installment plan could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The installment plan could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve installment plan based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1installmentPlans~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/InstallmentPlan","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InstallmentPlan"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/installment-plans/patchinstallmentplan"}],"panels":[]}]},"httpPath":"/installmentPlans/{tenantId}/{id}"},{"label":"Updates a installment plan with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/installment-plans/updateinstallmentplan","routeSlug":"/apis/collect/collect-v1/installment-plans/updateinstallmentplan","metadata":{"seo":{"title":"Updates a installment plan with the specified ID.","description":"This method will update an existing installment plan with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateInstallmentPlan","name":"Updates a installment plan with the specified ID.","isWebhook":false,"pointer":"/paths/~1installmentPlans~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a installment plan with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing installment plan with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the installment plan to update.","required":true}],"pointer":"/paths/~1installmentPlans~1{tenantId}~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/InstallmentPlan"}},"schemaId":"components/schemas/InstallmentPlan","pointer":"/paths/~1installmentPlans~1{tenantId}~1{id}/put/requestBody","description":"The updated installment plan that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/installmentPlans/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/InstallmentPlan"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/installmentPlans/{tenantId}/{id}","href":"installment-plans/updateinstallmentplan","openApiOperationId":"updateInstallmentPlan","summary":"Updates a installment plan with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/InstallmentPlan","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/InstallmentPlan"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The installment plan was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InstallmentPlan"}},"schemaId":"components/schemas/InstallmentPlan","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The installment plan supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The installment plan could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The installment plan could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve installment plan based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1installmentPlans~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/InstallmentPlan","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InstallmentPlan"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/installment-plans/updateinstallmentplan"}],"panels":[]}]},"httpPath":"/installmentPlans/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Installment Plans"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Installment Plans","showPageActions":true},{"nodeType":"markdoc","content":"Installment Plans"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/installmentPlans/{tenantId}","summary":"Gets all of the installment plans in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/installment-plans/listinstallmentplans","deprecated":false},{"title":"/installmentPlans/{tenantId}","summary":"Creates a new installment plan record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/installment-plans/createinstallmentplan","deprecated":false},{"title":"/installmentPlans/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/installment-plans/executebatchoperations","deprecated":false},{"title":"/installmentPlans/{tenantId}/{id}","summary":"Returns a installment plan from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/installment-plans/deleteinstallmentplan","deprecated":false},{"title":"/installmentPlans/{tenantId}/{id}","summary":"Returns a installment plan from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/installment-plans/getinstallmentplan","deprecated":false},{"title":"/installmentPlans/{tenantId}/{id}","summary":"Partially updates a installment plan with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/installment-plans/patchinstallmentplan","deprecated":false},{"title":"/installmentPlans/{tenantId}/{id}","summary":"Updates a installment plan with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/installment-plans/updateinstallmentplan","deprecated":false}]}]}]}]}},{"type":"group","label":"Installment Schedules","link":"/apis/collect/collect-v1/installment-schedules","routeSlug":"/apis/collect/collect-v1/installment-schedules","items":[{"label":"Gets all of the installment schedules in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/installment-schedules/listinstallmentschedules","routeSlug":"/apis/collect/collect-v1/installment-schedules/listinstallmentschedules","metadata":{"seo":{"title":"Gets all of the installment schedules in the system.","description":"This method will scan all installment schedules and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listInstallmentSchedules","name":"Gets all of the installment schedules in the system.","isWebhook":false,"pointer":"/paths/~1installmentSchedules~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the installment schedules in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all installment schedules and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1installmentSchedules~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1installmentSchedules~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/installmentSchedules/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/installmentSchedules/{tenantId}","href":"installment-schedules/listinstallmentschedules","openApiOperationId":"listInstallmentSchedules","summary":"Gets all of the installment schedules in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The installment scheduleswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_438"}},"schemaId":"schema_438","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1installmentSchedules~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_438","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_438"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/installment-schedules/listinstallmentschedules"}],"panels":[]}]},"httpPath":"/installmentSchedules/{tenantId}"},{"label":"Creates a new installment schedule record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/installment-schedules/createinstallmentschedule","routeSlug":"/apis/collect/collect-v1/installment-schedules/createinstallmentschedule","metadata":{"seo":{"title":"Creates a new installment schedule record that does not already exist.","description":"This method will auto-generate an ID and create a new installment schedule. If an ID is specified for the installment schedule, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createInstallmentSchedule","name":"Creates a new installment schedule record that does not already exist.","isWebhook":false,"pointer":"/paths/~1installmentSchedules~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new installment schedule record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new installment schedule. If an ID is specified for the installment schedule, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1installmentSchedules~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/InstallmentSchedule"}},"schemaId":"components/schemas/InstallmentSchedule","pointer":"/paths/~1installmentSchedules~1{tenantId}/post/requestBody","description":"The installment schedule that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/installmentSchedules/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/InstallmentSchedule"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/installmentSchedules/{tenantId}","href":"installment-schedules/createinstallmentschedule","openApiOperationId":"createInstallmentSchedule","summary":"Creates a new installment schedule record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/InstallmentSchedule","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/InstallmentSchedule"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The installment schedule was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InstallmentSchedule"}},"schemaId":"components/schemas/InstallmentSchedule","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The installment schedule you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The installment schedule could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add installment schedule based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1installmentSchedules~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/InstallmentSchedule","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InstallmentSchedule"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/installment-schedules/createinstallmentschedule"}],"panels":[]}]},"httpPath":"/installmentSchedules/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/installment-schedules/executebatchoperations","routeSlug":"/apis/collect/collect-v1/installment-schedules/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1installmentSchedules~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1installmentSchedules~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1installmentSchedules~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/installmentSchedules/{tenantId}/batch","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/installmentSchedules/{tenantId}/batch","href":"installment-schedules/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The installment schedule could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve installment schedule based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1installmentSchedules~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/installment-schedules/executebatchoperations"}],"panels":[]}]},"httpPath":"/installmentSchedules/{tenantId}/batch"},{"label":"Returns all installment schedules by order id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/installment-schedules/listinstallmentschedulesbyorderid","routeSlug":"/apis/collect/collect-v1/installment-schedules/listinstallmentschedulesbyorderid","metadata":{"seo":{"title":"Returns all installment schedules by order id","description":"Returns all installment schedules by order id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listInstallmentSchedulesByOrderId","name":"Returns all installment schedules by order id","isWebhook":false,"pointer":"/paths/~1installmentSchedules~1{tenantId}~1order~1{orderId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns all installment schedules by order id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns all installment schedules by order id"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed","required":true},{"name":"orderId","in":"path","schemaId":"schema_409","description":"The ID of the order","required":true}],"pointer":"/paths/~1installmentSchedules~1{tenantId}~1order~1{orderId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned"}],"pointer":"/paths/~1installmentSchedules~1{tenantId}~1order~1{orderId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/installmentSchedules/{tenantId}/order/{orderId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"orderId","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/installmentSchedules/{tenantId}/order/{orderId}","href":"installment-schedules/listinstallmentschedulesbyorderid","openApiOperationId":"listInstallmentSchedulesByOrderId","summary":"Returns all installment schedules by order id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The installment schedule was retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_438"}},"schemaId":"schema_438","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The installment schedule could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve installment schedule based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1installmentSchedules~1{tenantId}~1order~1{orderId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_438","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_438"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/installment-schedules/listinstallmentschedulesbyorderid"}],"panels":[]}]},"httpPath":"/installmentSchedules/{tenantId}/order/{orderId}"},{"label":"Process Installment Schedule","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/installment-schedules/processinstallmentschedule","routeSlug":"/apis/collect/collect-v1/installment-schedules/processinstallmentschedule","metadata":{"seo":{"title":"Process Installment Schedule","description":"Will process the schedule, creating invoices/payments or orders as necessary"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"processInstallmentSchedule","name":"Process Installment Schedule","isWebhook":false,"pointer":"/paths/~1installmentSchedules~1{tenantId}~1process/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Process Installment Schedule","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Will process the schedule, creating invoices/payments or orders as necessary"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed","required":true}],"pointer":"/paths/~1installmentSchedules~1{tenantId}~1process/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ProcessingRequest"}},"schemaId":"components/schemas/ProcessingRequest","pointer":"/paths/~1installmentSchedules~1{tenantId}~1process/post/requestBody","description":"The request payload"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/installmentSchedules/{tenantId}/process","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ProcessingRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/installmentSchedules/{tenantId}/process","href":"installment-schedules/processinstallmentschedule","openApiOperationId":"processInstallmentSchedule","summary":"Process Installment Schedule"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ProcessingRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ProcessingRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Conflicts were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_415"}},"schemaId":"schema_415","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The search you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add order based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1installmentSchedules~1{tenantId}~1process/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_415","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_415"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/installment-schedules/processinstallmentschedule"}],"panels":[]}]},"httpPath":"/installmentSchedules/{tenantId}/process"},{"label":"Returns a installment schedule from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/installment-schedules/deleteinstallmentschedule","routeSlug":"/apis/collect/collect-v1/installment-schedules/deleteinstallmentschedule","metadata":{"seo":{"title":"Returns a installment schedule from the system by its ID.","description":"This method will delete a installment schedule with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteInstallmentSchedule","name":"Returns a installment schedule from the system by its ID.","isWebhook":false,"pointer":"/paths/~1installmentSchedules~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a installment schedule from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a installment schedule with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the installment schedule to delete.","required":true}],"pointer":"/paths/~1installmentSchedules~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/installmentSchedules/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/installmentSchedules/{tenantId}/{id}","href":"installment-schedules/deleteinstallmentschedule","openApiOperationId":"deleteInstallmentSchedule","summary":"Returns a installment schedule from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The installment schedule was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}},"schemaId":"schema_409","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The installment schedule could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The installment schedule could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to delete installment schedule based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1installmentSchedules~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_409","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/installment-schedules/deleteinstallmentschedule"}],"panels":[]}]},"httpPath":"/installmentSchedules/{tenantId}/{id}"},{"label":"Returns a installment schedule from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/installment-schedules/getinstallmentschedule","routeSlug":"/apis/collect/collect-v1/installment-schedules/getinstallmentschedule","metadata":{"seo":{"title":"Returns a installment schedule from the system by its ID.","description":"This method will look up a installment schedule by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getInstallmentSchedule","name":"Returns a installment schedule from the system by its ID.","isWebhook":false,"pointer":"/paths/~1installmentSchedules~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a installment schedule from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a installment schedule by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the installment schedule to return.","required":true}],"pointer":"/paths/~1installmentSchedules~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_409","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1installmentSchedules~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/installmentSchedules/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/installmentSchedules/{tenantId}/{id}","href":"installment-schedules/getinstallmentschedule","openApiOperationId":"getInstallmentSchedule","summary":"Returns a installment schedule from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The installment schedule was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InstallmentSchedule"}},"schemaId":"components/schemas/InstallmentSchedule","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The installment schedule could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve installment schedule based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1installmentSchedules~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/InstallmentSchedule","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InstallmentSchedule"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/installment-schedules/getinstallmentschedule"}],"panels":[]}]},"httpPath":"/installmentSchedules/{tenantId}/{id}"},{"label":"Partially updates a installment schedule with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/installment-schedules/patchinstallmentschedule","routeSlug":"/apis/collect/collect-v1/installment-schedules/patchinstallmentschedule","metadata":{"seo":{"title":"Partially updates a installment schedule with the specified ID.","description":"This method will patch an existing installment schedule with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchInstallmentSchedule","name":"Partially updates a installment schedule with the specified ID.","isWebhook":false,"pointer":"/paths/~1installmentSchedules~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a installment schedule with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing installment schedule with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the installment schedule to patch.","required":true}],"pointer":"/paths/~1installmentSchedules~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"schemaId":"schema_412","pointer":"/paths/~1installmentSchedules~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/installmentSchedules/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_412"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/installmentSchedules/{tenantId}/{id}","href":"installment-schedules/patchinstallmentschedule","openApiOperationId":"patchInstallmentSchedule","summary":"Partially updates a installment schedule with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"schema_412","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The installment schedule was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InstallmentSchedule"}},"schemaId":"components/schemas/InstallmentSchedule","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The installment schedule could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The installment schedule could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve installment schedule based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1installmentSchedules~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/InstallmentSchedule","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InstallmentSchedule"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/installment-schedules/patchinstallmentschedule"}],"panels":[]}]},"httpPath":"/installmentSchedules/{tenantId}/{id}"},{"label":"Updates a installment schedule with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/installment-schedules/updateinstallmentschedule","routeSlug":"/apis/collect/collect-v1/installment-schedules/updateinstallmentschedule","metadata":{"seo":{"title":"Updates a installment schedule with the specified ID.","description":"This method will update an existing installment schedule with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateInstallmentSchedule","name":"Updates a installment schedule with the specified ID.","isWebhook":false,"pointer":"/paths/~1installmentSchedules~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a installment schedule with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing installment schedule with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the installment schedule to update.","required":true}],"pointer":"/paths/~1installmentSchedules~1{tenantId}~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/InstallmentSchedule"}},"schemaId":"components/schemas/InstallmentSchedule","pointer":"/paths/~1installmentSchedules~1{tenantId}~1{id}/put/requestBody","description":"The updated installment schedule that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/installmentSchedules/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/InstallmentSchedule"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/installmentSchedules/{tenantId}/{id}","href":"installment-schedules/updateinstallmentschedule","openApiOperationId":"updateInstallmentSchedule","summary":"Updates a installment schedule with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/InstallmentSchedule","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/InstallmentSchedule"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The installment schedule was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InstallmentSchedule"}},"schemaId":"components/schemas/InstallmentSchedule","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The installment schedule supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The installment schedule could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The installment schedule could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve installment schedule based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1installmentSchedules~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/InstallmentSchedule","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InstallmentSchedule"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/installment-schedules/updateinstallmentschedule"}],"panels":[]}]},"httpPath":"/installmentSchedules/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Installment Schedules"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Installment Schedules","showPageActions":true},{"nodeType":"markdoc","content":"Installment Schedules"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/installmentSchedules/{tenantId}","summary":"Gets all of the installment schedules in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/installment-schedules/listinstallmentschedules","deprecated":false},{"title":"/installmentSchedules/{tenantId}","summary":"Creates a new installment schedule record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/installment-schedules/createinstallmentschedule","deprecated":false},{"title":"/installmentSchedules/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/installment-schedules/executebatchoperations","deprecated":false},{"title":"/installmentSchedules/{tenantId}/order/{orderId}","summary":"Returns all installment schedules by order id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/installment-schedules/listinstallmentschedulesbyorderid","deprecated":false},{"title":"/installmentSchedules/{tenantId}/process","summary":"Process Installment Schedule","prefix":{"name":"post","color":"post"},"badges":[],"link":"/installment-schedules/processinstallmentschedule","deprecated":false},{"title":"/installmentSchedules/{tenantId}/{id}","summary":"Returns a installment schedule from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/installment-schedules/deleteinstallmentschedule","deprecated":false},{"title":"/installmentSchedules/{tenantId}/{id}","summary":"Returns a installment schedule from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/installment-schedules/getinstallmentschedule","deprecated":false},{"title":"/installmentSchedules/{tenantId}/{id}","summary":"Partially updates a installment schedule with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/installment-schedules/patchinstallmentschedule","deprecated":false},{"title":"/installmentSchedules/{tenantId}/{id}","summary":"Updates a installment schedule with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/installment-schedules/updateinstallmentschedule","deprecated":false}]}]}]}]}},{"type":"group","label":"Invoice Payment Terms","link":"/apis/collect/collect-v1/invoice-payment-terms","routeSlug":"/apis/collect/collect-v1/invoice-payment-terms","items":[{"label":"Gets all of the invoice payment terms in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoice-payment-terms/listinvoicepaymentterms","routeSlug":"/apis/collect/collect-v1/invoice-payment-terms/listinvoicepaymentterms","metadata":{"seo":{"title":"Gets all of the invoice payment terms in the system.","description":"This method will scan all invoice payment terms and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listInvoicePaymentTerms","name":"Gets all of the invoice payment terms in the system.","isWebhook":false,"pointer":"/paths/~1invoicePaymentTerms~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the invoice payment terms in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all invoice payment terms and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1invoicePaymentTerms~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1invoicePaymentTerms~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/invoicePaymentTerms/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/invoicePaymentTerms/{tenantId}","href":"invoice-payment-terms/listinvoicepaymentterms","openApiOperationId":"listInvoicePaymentTerms","summary":"Gets all of the invoice payment terms in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The invoice payment termswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_439"}},"schemaId":"schema_439","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1invoicePaymentTerms~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_439","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_439"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoice-payment-terms/listinvoicepaymentterms"}],"panels":[]}]},"httpPath":"/invoicePaymentTerms/{tenantId}"},{"label":"Creates a new invoice payment term record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoice-payment-terms/createinvoicepaymentterm","routeSlug":"/apis/collect/collect-v1/invoice-payment-terms/createinvoicepaymentterm","metadata":{"seo":{"title":"Creates a new invoice payment term record that does not already exist.","description":"This method will auto-generate an ID and create a new invoice payment term. If an ID is specified for the invoice payment term, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createInvoicePaymentTerm","name":"Creates a new invoice payment term record that does not already exist.","isWebhook":false,"pointer":"/paths/~1invoicePaymentTerms~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new invoice payment term record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new invoice payment term. If an ID is specified for the invoice payment term, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1invoicePaymentTerms~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/InvoicePaymentTerm"}},"schemaId":"components/schemas/InvoicePaymentTerm","pointer":"/paths/~1invoicePaymentTerms~1{tenantId}/post/requestBody","description":"The invoice payment term that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/invoicePaymentTerms/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/InvoicePaymentTerm"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/invoicePaymentTerms/{tenantId}","href":"invoice-payment-terms/createinvoicepaymentterm","openApiOperationId":"createInvoicePaymentTerm","summary":"Creates a new invoice payment term record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/InvoicePaymentTerm","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/InvoicePaymentTerm"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The invoice payment term was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvoicePaymentTerm"}},"schemaId":"components/schemas/InvoicePaymentTerm","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The invoice payment term you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The invoice payment term could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add invoice payment term based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1invoicePaymentTerms~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/InvoicePaymentTerm","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvoicePaymentTerm"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoice-payment-terms/createinvoicepaymentterm"}],"panels":[]}]},"httpPath":"/invoicePaymentTerms/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoice-payment-terms/executebatchoperations","routeSlug":"/apis/collect/collect-v1/invoice-payment-terms/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1invoicePaymentTerms~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1invoicePaymentTerms~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1invoicePaymentTerms~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/invoicePaymentTerms/{tenantId}/batch","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/invoicePaymentTerms/{tenantId}/batch","href":"invoice-payment-terms/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The invoice payment term could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve invoice payment term based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1invoicePaymentTerms~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoice-payment-terms/executebatchoperations"}],"panels":[]}]},"httpPath":"/invoicePaymentTerms/{tenantId}/batch"},{"label":"Returns a invoice payment term from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoice-payment-terms/deleteinvoicepaymentterm","routeSlug":"/apis/collect/collect-v1/invoice-payment-terms/deleteinvoicepaymentterm","metadata":{"seo":{"title":"Returns a invoice payment term from the system by its ID.","description":"This method will delete a invoice payment term with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteInvoicePaymentTerm","name":"Returns a invoice payment term from the system by its ID.","isWebhook":false,"pointer":"/paths/~1invoicePaymentTerms~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a invoice payment term from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a invoice payment term with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the invoice payment term to delete.","required":true}],"pointer":"/paths/~1invoicePaymentTerms~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/invoicePaymentTerms/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/invoicePaymentTerms/{tenantId}/{id}","href":"invoice-payment-terms/deleteinvoicepaymentterm","openApiOperationId":"deleteInvoicePaymentTerm","summary":"Returns a invoice payment term from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The invoice payment term was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}},"schemaId":"schema_409","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The invoice payment term could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The invoice payment term could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to delete invoice payment term based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1invoicePaymentTerms~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_409","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoice-payment-terms/deleteinvoicepaymentterm"}],"panels":[]}]},"httpPath":"/invoicePaymentTerms/{tenantId}/{id}"},{"label":"Returns a invoice payment term from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoice-payment-terms/getinvoicepaymentterm","routeSlug":"/apis/collect/collect-v1/invoice-payment-terms/getinvoicepaymentterm","metadata":{"seo":{"title":"Returns a invoice payment term from the system by its ID.","description":"This method will look up a invoice payment term by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getInvoicePaymentTerm","name":"Returns a invoice payment term from the system by its ID.","isWebhook":false,"pointer":"/paths/~1invoicePaymentTerms~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a invoice payment term from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a invoice payment term by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the invoice payment term to return.","required":true}],"pointer":"/paths/~1invoicePaymentTerms~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_409","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1invoicePaymentTerms~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/invoicePaymentTerms/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/invoicePaymentTerms/{tenantId}/{id}","href":"invoice-payment-terms/getinvoicepaymentterm","openApiOperationId":"getInvoicePaymentTerm","summary":"Returns a invoice payment term from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The invoice payment term was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvoicePaymentTerm"}},"schemaId":"components/schemas/InvoicePaymentTerm","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The invoice payment term could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve invoice payment term based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1invoicePaymentTerms~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/InvoicePaymentTerm","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvoicePaymentTerm"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoice-payment-terms/getinvoicepaymentterm"}],"panels":[]}]},"httpPath":"/invoicePaymentTerms/{tenantId}/{id}"},{"label":"Partially updates a invoice payment term with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoice-payment-terms/patchinvoicepaymentterm","routeSlug":"/apis/collect/collect-v1/invoice-payment-terms/patchinvoicepaymentterm","metadata":{"seo":{"title":"Partially updates a invoice payment term with the specified ID.","description":"This method will patch an existing invoice payment term with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchInvoicePaymentTerm","name":"Partially updates a invoice payment term with the specified ID.","isWebhook":false,"pointer":"/paths/~1invoicePaymentTerms~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a invoice payment term with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing invoice payment term with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the invoice payment term to patch.","required":true}],"pointer":"/paths/~1invoicePaymentTerms~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"schemaId":"schema_412","pointer":"/paths/~1invoicePaymentTerms~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/invoicePaymentTerms/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_412"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/invoicePaymentTerms/{tenantId}/{id}","href":"invoice-payment-terms/patchinvoicepaymentterm","openApiOperationId":"patchInvoicePaymentTerm","summary":"Partially updates a invoice payment term with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"schema_412","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The invoice payment term was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvoicePaymentTerm"}},"schemaId":"components/schemas/InvoicePaymentTerm","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The invoice payment term could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The invoice payment term could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve invoice payment term based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1invoicePaymentTerms~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/InvoicePaymentTerm","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvoicePaymentTerm"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoice-payment-terms/patchinvoicepaymentterm"}],"panels":[]}]},"httpPath":"/invoicePaymentTerms/{tenantId}/{id}"},{"label":"Updates a invoice payment term with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoice-payment-terms/updateinvoicepaymentterm","routeSlug":"/apis/collect/collect-v1/invoice-payment-terms/updateinvoicepaymentterm","metadata":{"seo":{"title":"Updates a invoice payment term with the specified ID.","description":"This method will update an existing invoice payment term with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateInvoicePaymentTerm","name":"Updates a invoice payment term with the specified ID.","isWebhook":false,"pointer":"/paths/~1invoicePaymentTerms~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a invoice payment term with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing invoice payment term with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the invoice payment term to update.","required":true}],"pointer":"/paths/~1invoicePaymentTerms~1{tenantId}~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/InvoicePaymentTerm"}},"schemaId":"components/schemas/InvoicePaymentTerm","pointer":"/paths/~1invoicePaymentTerms~1{tenantId}~1{id}/put/requestBody","description":"The updated invoice payment term that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/invoicePaymentTerms/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/InvoicePaymentTerm"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/invoicePaymentTerms/{tenantId}/{id}","href":"invoice-payment-terms/updateinvoicepaymentterm","openApiOperationId":"updateInvoicePaymentTerm","summary":"Updates a invoice payment term with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/InvoicePaymentTerm","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/InvoicePaymentTerm"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The invoice payment term was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvoicePaymentTerm"}},"schemaId":"components/schemas/InvoicePaymentTerm","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The invoice payment term supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The invoice payment term could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The invoice payment term could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve invoice payment term based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1invoicePaymentTerms~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/InvoicePaymentTerm","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvoicePaymentTerm"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoice-payment-terms/updateinvoicepaymentterm"}],"panels":[]}]},"httpPath":"/invoicePaymentTerms/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Invoice Payment Terms"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Invoice Payment Terms","showPageActions":true},{"nodeType":"markdoc","content":"Invoice Payment Terms"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/invoicePaymentTerms/{tenantId}","summary":"Gets all of the invoice payment terms in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/invoice-payment-terms/listinvoicepaymentterms","deprecated":false},{"title":"/invoicePaymentTerms/{tenantId}","summary":"Creates a new invoice payment term record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/invoice-payment-terms/createinvoicepaymentterm","deprecated":false},{"title":"/invoicePaymentTerms/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/invoice-payment-terms/executebatchoperations","deprecated":false},{"title":"/invoicePaymentTerms/{tenantId}/{id}","summary":"Returns a invoice payment term from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/invoice-payment-terms/deleteinvoicepaymentterm","deprecated":false},{"title":"/invoicePaymentTerms/{tenantId}/{id}","summary":"Returns a invoice payment term from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/invoice-payment-terms/getinvoicepaymentterm","deprecated":false},{"title":"/invoicePaymentTerms/{tenantId}/{id}","summary":"Partially updates a invoice payment term with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/invoice-payment-terms/patchinvoicepaymentterm","deprecated":false},{"title":"/invoicePaymentTerms/{tenantId}/{id}","summary":"Updates a invoice payment term with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/invoice-payment-terms/updateinvoicepaymentterm","deprecated":false}]}]}]}]}},{"type":"group","label":"Invoice Templates","link":"/apis/collect/collect-v1/invoice-templates","routeSlug":"/apis/collect/collect-v1/invoice-templates","items":[{"label":"Gets all of the invoice templates in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoice-templates/listinvoicetemplates","routeSlug":"/apis/collect/collect-v1/invoice-templates/listinvoicetemplates","metadata":{"seo":{"title":"Gets all of the invoice templates in the system.","description":"This method will scan all invoice templates and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listInvoiceTemplates","name":"Gets all of the invoice templates in the system.","isWebhook":false,"pointer":"/paths/~1invoiceTemplates~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the invoice templates in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all invoice templates and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1invoiceTemplates~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1invoiceTemplates~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/invoiceTemplates/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/invoiceTemplates/{tenantId}","href":"invoice-templates/listinvoicetemplates","openApiOperationId":"listInvoiceTemplates","summary":"Gets all of the invoice templates in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The invoice templateswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_440"}},"schemaId":"schema_440","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1invoiceTemplates~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_440","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_440"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoice-templates/listinvoicetemplates"}],"panels":[]}]},"httpPath":"/invoiceTemplates/{tenantId}"},{"label":"Creates a new invoice template record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoice-templates/createinvoicetemplate","routeSlug":"/apis/collect/collect-v1/invoice-templates/createinvoicetemplate","metadata":{"seo":{"title":"Creates a new invoice template record that does not already exist.","description":"This method will auto-generate an ID and create a new invoice template. If an ID is specified for the invoice template, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createInvoiceTemplate","name":"Creates a new invoice template record that does not already exist.","isWebhook":false,"pointer":"/paths/~1invoiceTemplates~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new invoice template record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new invoice template. If an ID is specified for the invoice template, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1invoiceTemplates~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/InvoiceTemplate"}},"schemaId":"components/schemas/InvoiceTemplate","pointer":"/paths/~1invoiceTemplates~1{tenantId}/post/requestBody","description":"The invoice template that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/invoiceTemplates/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/InvoiceTemplate"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/invoiceTemplates/{tenantId}","href":"invoice-templates/createinvoicetemplate","openApiOperationId":"createInvoiceTemplate","summary":"Creates a new invoice template record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/InvoiceTemplate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/InvoiceTemplate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The invoice template was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvoiceTemplate"}},"schemaId":"components/schemas/InvoiceTemplate","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The invoice template you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The invoice template could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add invoice template based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1invoiceTemplates~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/InvoiceTemplate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvoiceTemplate"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoice-templates/createinvoicetemplate"}],"panels":[]}]},"httpPath":"/invoiceTemplates/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoice-templates/executebatchoperations","routeSlug":"/apis/collect/collect-v1/invoice-templates/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1invoiceTemplates~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1invoiceTemplates~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1invoiceTemplates~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/invoiceTemplates/{tenantId}/batch","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/invoiceTemplates/{tenantId}/batch","href":"invoice-templates/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The invoice template could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve invoice template based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1invoiceTemplates~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoice-templates/executebatchoperations"}],"panels":[]}]},"httpPath":"/invoiceTemplates/{tenantId}/batch"},{"label":"Returns a invoice template from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoice-templates/deleteinvoicetemplate","routeSlug":"/apis/collect/collect-v1/invoice-templates/deleteinvoicetemplate","metadata":{"seo":{"title":"Returns a invoice template from the system by its ID.","description":"This method will delete a invoice template with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteInvoiceTemplate","name":"Returns a invoice template from the system by its ID.","isWebhook":false,"pointer":"/paths/~1invoiceTemplates~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a invoice template from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a invoice template with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the invoice template to delete.","required":true}],"pointer":"/paths/~1invoiceTemplates~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/invoiceTemplates/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/invoiceTemplates/{tenantId}/{id}","href":"invoice-templates/deleteinvoicetemplate","openApiOperationId":"deleteInvoiceTemplate","summary":"Returns a invoice template from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The invoice template was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}},"schemaId":"schema_409","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The invoice template could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The invoice template could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to delete invoice template based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1invoiceTemplates~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_409","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoice-templates/deleteinvoicetemplate"}],"panels":[]}]},"httpPath":"/invoiceTemplates/{tenantId}/{id}"},{"label":"Returns a invoice template from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoice-templates/getinvoicetemplate","routeSlug":"/apis/collect/collect-v1/invoice-templates/getinvoicetemplate","metadata":{"seo":{"title":"Returns a invoice template from the system by its ID.","description":"This method will look up a invoice template by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getInvoiceTemplate","name":"Returns a invoice template from the system by its ID.","isWebhook":false,"pointer":"/paths/~1invoiceTemplates~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a invoice template from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a invoice template by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the invoice template to return.","required":true}],"pointer":"/paths/~1invoiceTemplates~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_409","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1invoiceTemplates~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/invoiceTemplates/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/invoiceTemplates/{tenantId}/{id}","href":"invoice-templates/getinvoicetemplate","openApiOperationId":"getInvoiceTemplate","summary":"Returns a invoice template from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The invoice template was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvoiceTemplate"}},"schemaId":"components/schemas/InvoiceTemplate","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The invoice template could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve invoice template based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1invoiceTemplates~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/InvoiceTemplate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvoiceTemplate"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoice-templates/getinvoicetemplate"}],"panels":[]}]},"httpPath":"/invoiceTemplates/{tenantId}/{id}"},{"label":"Partially updates a invoice template with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoice-templates/patchinvoicetemplate","routeSlug":"/apis/collect/collect-v1/invoice-templates/patchinvoicetemplate","metadata":{"seo":{"title":"Partially updates a invoice template with the specified ID.","description":"This method will patch an existing invoice template with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchInvoiceTemplate","name":"Partially updates a invoice template with the specified ID.","isWebhook":false,"pointer":"/paths/~1invoiceTemplates~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a invoice template with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing invoice template with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the invoice template to patch.","required":true}],"pointer":"/paths/~1invoiceTemplates~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"schemaId":"schema_412","pointer":"/paths/~1invoiceTemplates~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/invoiceTemplates/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_412"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/invoiceTemplates/{tenantId}/{id}","href":"invoice-templates/patchinvoicetemplate","openApiOperationId":"patchInvoiceTemplate","summary":"Partially updates a invoice template with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"schema_412","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The invoice template was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvoiceTemplate"}},"schemaId":"components/schemas/InvoiceTemplate","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The invoice template could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The invoice template could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve invoice template based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1invoiceTemplates~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/InvoiceTemplate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvoiceTemplate"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoice-templates/patchinvoicetemplate"}],"panels":[]}]},"httpPath":"/invoiceTemplates/{tenantId}/{id}"},{"label":"Updates a invoice template with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoice-templates/updateinvoicetemplate","routeSlug":"/apis/collect/collect-v1/invoice-templates/updateinvoicetemplate","metadata":{"seo":{"title":"Updates a invoice template with the specified ID.","description":"This method will update an existing invoice template with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateInvoiceTemplate","name":"Updates a invoice template with the specified ID.","isWebhook":false,"pointer":"/paths/~1invoiceTemplates~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a invoice template with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing invoice template with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the invoice template to update.","required":true}],"pointer":"/paths/~1invoiceTemplates~1{tenantId}~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/InvoiceTemplate"}},"schemaId":"components/schemas/InvoiceTemplate","pointer":"/paths/~1invoiceTemplates~1{tenantId}~1{id}/put/requestBody","description":"The updated invoice template that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/invoiceTemplates/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/InvoiceTemplate"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/invoiceTemplates/{tenantId}/{id}","href":"invoice-templates/updateinvoicetemplate","openApiOperationId":"updateInvoiceTemplate","summary":"Updates a invoice template with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/InvoiceTemplate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/InvoiceTemplate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The invoice template was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvoiceTemplate"}},"schemaId":"components/schemas/InvoiceTemplate","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The invoice template supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The invoice template could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The invoice template could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve invoice template based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1invoiceTemplates~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/InvoiceTemplate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvoiceTemplate"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoice-templates/updateinvoicetemplate"}],"panels":[]}]},"httpPath":"/invoiceTemplates/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Invoice Templates"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Invoice Templates","showPageActions":true},{"nodeType":"markdoc","content":"Invoice Templates"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/invoiceTemplates/{tenantId}","summary":"Gets all of the invoice templates in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/invoice-templates/listinvoicetemplates","deprecated":false},{"title":"/invoiceTemplates/{tenantId}","summary":"Creates a new invoice template record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/invoice-templates/createinvoicetemplate","deprecated":false},{"title":"/invoiceTemplates/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/invoice-templates/executebatchoperations","deprecated":false},{"title":"/invoiceTemplates/{tenantId}/{id}","summary":"Returns a invoice template from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/invoice-templates/deleteinvoicetemplate","deprecated":false},{"title":"/invoiceTemplates/{tenantId}/{id}","summary":"Returns a invoice template from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/invoice-templates/getinvoicetemplate","deprecated":false},{"title":"/invoiceTemplates/{tenantId}/{id}","summary":"Partially updates a invoice template with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/invoice-templates/patchinvoicetemplate","deprecated":false},{"title":"/invoiceTemplates/{tenantId}/{id}","summary":"Updates a invoice template with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/invoice-templates/updateinvoicetemplate","deprecated":false}]}]}]}]}},{"type":"group","label":"Invoice Types","link":"/apis/collect/collect-v1/invoice-types","routeSlug":"/apis/collect/collect-v1/invoice-types","items":[{"label":"Gets all of the invoice types in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoice-types/listinvoicetypes","routeSlug":"/apis/collect/collect-v1/invoice-types/listinvoicetypes","metadata":{"seo":{"title":"Gets all of the invoice types in the system.","description":"This method will scan all invoice types and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listInvoiceTypes","name":"Gets all of the invoice types in the system.","isWebhook":false,"pointer":"/paths/~1invoiceTypes~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the invoice types in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all invoice types and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1invoiceTypes~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1invoiceTypes~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/invoiceTypes/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/invoiceTypes/{tenantId}","href":"invoice-types/listinvoicetypes","openApiOperationId":"listInvoiceTypes","summary":"Gets all of the invoice types in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The invoice typeswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_441"}},"schemaId":"schema_441","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1invoiceTypes~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_441","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_441"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoice-types/listinvoicetypes"}],"panels":[]}]},"httpPath":"/invoiceTypes/{tenantId}"},{"label":"Creates a new invoice type record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoice-types/createinvoicetype","routeSlug":"/apis/collect/collect-v1/invoice-types/createinvoicetype","metadata":{"seo":{"title":"Creates a new invoice type record that does not already exist.","description":"This method will auto-generate an ID and create a new invoice type. If an ID is specified for the invoice type, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createInvoiceType","name":"Creates a new invoice type record that does not already exist.","isWebhook":false,"pointer":"/paths/~1invoiceTypes~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new invoice type record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new invoice type. If an ID is specified for the invoice type, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1invoiceTypes~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/InvoiceType"}},"schemaId":"components/schemas/InvoiceType","pointer":"/paths/~1invoiceTypes~1{tenantId}/post/requestBody","description":"The invoice type that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/invoiceTypes/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/InvoiceType"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/invoiceTypes/{tenantId}","href":"invoice-types/createinvoicetype","openApiOperationId":"createInvoiceType","summary":"Creates a new invoice type record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/InvoiceType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/InvoiceType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The invoice type was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvoiceType"}},"schemaId":"components/schemas/InvoiceType","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The invoice type you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The invoice type could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add invoice type based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1invoiceTypes~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/InvoiceType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvoiceType"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoice-types/createinvoicetype"}],"panels":[]}]},"httpPath":"/invoiceTypes/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoice-types/executebatchoperations","routeSlug":"/apis/collect/collect-v1/invoice-types/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1invoiceTypes~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1invoiceTypes~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1invoiceTypes~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/invoiceTypes/{tenantId}/batch","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/invoiceTypes/{tenantId}/batch","href":"invoice-types/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The invoice type could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve invoice type based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1invoiceTypes~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoice-types/executebatchoperations"}],"panels":[]}]},"httpPath":"/invoiceTypes/{tenantId}/batch"},{"label":"Returns a invoice type from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoice-types/deleteinvoicetype","routeSlug":"/apis/collect/collect-v1/invoice-types/deleteinvoicetype","metadata":{"seo":{"title":"Returns a invoice type from the system by its ID.","description":"This method will delete a invoice type with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteInvoiceType","name":"Returns a invoice type from the system by its ID.","isWebhook":false,"pointer":"/paths/~1invoiceTypes~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a invoice type from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a invoice type with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the invoice type to delete.","required":true}],"pointer":"/paths/~1invoiceTypes~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/invoiceTypes/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/invoiceTypes/{tenantId}/{id}","href":"invoice-types/deleteinvoicetype","openApiOperationId":"deleteInvoiceType","summary":"Returns a invoice type from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The invoice type was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}},"schemaId":"schema_409","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The invoice type could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The invoice type could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to delete invoice type based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1invoiceTypes~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_409","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoice-types/deleteinvoicetype"}],"panels":[]}]},"httpPath":"/invoiceTypes/{tenantId}/{id}"},{"label":"Returns a invoice type from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoice-types/getinvoicetype","routeSlug":"/apis/collect/collect-v1/invoice-types/getinvoicetype","metadata":{"seo":{"title":"Returns a invoice type from the system by its ID.","description":"This method will look up a invoice type by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getInvoiceType","name":"Returns a invoice type from the system by its ID.","isWebhook":false,"pointer":"/paths/~1invoiceTypes~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a invoice type from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a invoice type by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the invoice type to return.","required":true}],"pointer":"/paths/~1invoiceTypes~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_409","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1invoiceTypes~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/invoiceTypes/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/invoiceTypes/{tenantId}/{id}","href":"invoice-types/getinvoicetype","openApiOperationId":"getInvoiceType","summary":"Returns a invoice type from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The invoice type was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvoiceType"}},"schemaId":"components/schemas/InvoiceType","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The invoice type could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve invoice type based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1invoiceTypes~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/InvoiceType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvoiceType"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoice-types/getinvoicetype"}],"panels":[]}]},"httpPath":"/invoiceTypes/{tenantId}/{id}"},{"label":"Partially updates a invoice type with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoice-types/patchinvoicetype","routeSlug":"/apis/collect/collect-v1/invoice-types/patchinvoicetype","metadata":{"seo":{"title":"Partially updates a invoice type with the specified ID.","description":"This method will patch an existing invoice type with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchInvoiceType","name":"Partially updates a invoice type with the specified ID.","isWebhook":false,"pointer":"/paths/~1invoiceTypes~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a invoice type with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing invoice type with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the invoice type to patch.","required":true}],"pointer":"/paths/~1invoiceTypes~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"schemaId":"schema_412","pointer":"/paths/~1invoiceTypes~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/invoiceTypes/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_412"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/invoiceTypes/{tenantId}/{id}","href":"invoice-types/patchinvoicetype","openApiOperationId":"patchInvoiceType","summary":"Partially updates a invoice type with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"schema_412","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The invoice type was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvoiceType"}},"schemaId":"components/schemas/InvoiceType","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The invoice type could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The invoice type could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve invoice type based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1invoiceTypes~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/InvoiceType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvoiceType"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoice-types/patchinvoicetype"}],"panels":[]}]},"httpPath":"/invoiceTypes/{tenantId}/{id}"},{"label":"Updates a invoice type with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoice-types/updateinvoicetype","routeSlug":"/apis/collect/collect-v1/invoice-types/updateinvoicetype","metadata":{"seo":{"title":"Updates a invoice type with the specified ID.","description":"This method will update an existing invoice type with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateInvoiceType","name":"Updates a invoice type with the specified ID.","isWebhook":false,"pointer":"/paths/~1invoiceTypes~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a invoice type with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing invoice type with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the invoice type to update.","required":true}],"pointer":"/paths/~1invoiceTypes~1{tenantId}~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/InvoiceType"}},"schemaId":"components/schemas/InvoiceType","pointer":"/paths/~1invoiceTypes~1{tenantId}~1{id}/put/requestBody","description":"The updated invoice type that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/invoiceTypes/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/InvoiceType"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/invoiceTypes/{tenantId}/{id}","href":"invoice-types/updateinvoicetype","openApiOperationId":"updateInvoiceType","summary":"Updates a invoice type with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/InvoiceType","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/InvoiceType"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The invoice type was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvoiceType"}},"schemaId":"components/schemas/InvoiceType","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The invoice type supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The invoice type could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The invoice type could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve invoice type based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1invoiceTypes~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/InvoiceType","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvoiceType"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoice-types/updateinvoicetype"}],"panels":[]}]},"httpPath":"/invoiceTypes/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Invoice Types"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Invoice Types","showPageActions":true},{"nodeType":"markdoc","content":"Invoice Types"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/invoiceTypes/{tenantId}","summary":"Gets all of the invoice types in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/invoice-types/listinvoicetypes","deprecated":false},{"title":"/invoiceTypes/{tenantId}","summary":"Creates a new invoice type record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/invoice-types/createinvoicetype","deprecated":false},{"title":"/invoiceTypes/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/invoice-types/executebatchoperations","deprecated":false},{"title":"/invoiceTypes/{tenantId}/{id}","summary":"Returns a invoice type from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/invoice-types/deleteinvoicetype","deprecated":false},{"title":"/invoiceTypes/{tenantId}/{id}","summary":"Returns a invoice type from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/invoice-types/getinvoicetype","deprecated":false},{"title":"/invoiceTypes/{tenantId}/{id}","summary":"Partially updates a invoice type with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/invoice-types/patchinvoicetype","deprecated":false},{"title":"/invoiceTypes/{tenantId}/{id}","summary":"Updates a invoice type with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/invoice-types/updateinvoicetype","deprecated":false}]}]}]}]}},{"type":"group","label":"Invoices","link":"/apis/collect/collect-v1/invoices","routeSlug":"/apis/collect/collect-v1/invoices","items":[{"label":"Returns the default invoice template","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoices/getdefaultinvoicetemplate","routeSlug":"/apis/collect/collect-v1/invoices/getdefaultinvoicetemplate","metadata":{"seo":{"title":"Returns the default invoice template","description":"Returns the default invoice template"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDefaultInvoiceTemplate","name":"Returns the default invoice template","isWebhook":false,"pointer":"/paths/~1invoices~1defaultTemplate~1invoice/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns the default invoice template","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the default invoice template"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/invoices/defaultTemplate/invoice","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/invoices/defaultTemplate/invoice","href":"invoices/getdefaultinvoicetemplate","openApiOperationId":"getDefaultInvoiceTemplate","summary":"Returns the default invoice template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The invoice template","mediaType":"text/html","mediaTypes":["text/html"],"mediaTypeContent":{"text/html":{"schemaId":"schema_409"}},"schemaId":"schema_409","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The invoice could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve invoice based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1invoices~1defaultTemplate~1invoice/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_409","mediaTypes":["text/html"],"mediaTypeContent":{"text/html":{"schemaId":"schema_409"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/getdefaultinvoicetemplate"}],"panels":[]}]},"httpPath":"/invoices/defaultTemplate/invoice"},{"label":"Returns the default invoice template","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoices/getdefaultinvoicetemplateandemail","routeSlug":"/apis/collect/collect-v1/invoices/getdefaultinvoicetemplateandemail","metadata":{"seo":{"title":"Returns the default invoice template","description":"Returns the default invoice template"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDefaultInvoiceTemplateAndEmail","name":"Returns the default invoice template","isWebhook":false,"pointer":"/paths/~1invoices~1defaultTemplateAndEmail~1invoice/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns the default invoice template","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the default invoice template"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/invoices/defaultTemplateAndEmail/invoice","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/invoices/defaultTemplateAndEmail/invoice","href":"invoices/getdefaultinvoicetemplateandemail","openApiOperationId":"getDefaultInvoiceTemplateAndEmail","summary":"Returns the default invoice template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The invoice template","mediaType":"text/html","mediaTypes":["text/html"],"mediaTypeContent":{"text/html":{"schemaId":"schema_442"}},"schemaId":"schema_442","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Request limit exceeded... please try your request again in a few seconds","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"An internal server error occured.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1invoices~1defaultTemplateAndEmail~1invoice/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_442","mediaTypes":["text/html"],"mediaTypeContent":{"text/html":{"schemaId":"schema_442"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/getdefaultinvoicetemplateandemail"}],"panels":[]}]},"httpPath":"/invoices/defaultTemplateAndEmail/invoice"},{"label":"Initiates workflow to warm up inventory transactions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoices/warmupstepfunctions","routeSlug":"/apis/collect/collect-v1/invoices/warmupstepfunctions","metadata":{"seo":{"title":"Initiates workflow to warm up inventory transactions","description":"Initiates workflow to warm up inventory transactions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"warmUpStepFunctions","name":"Initiates workflow to warm up inventory transactions","isWebhook":false,"pointer":"/paths/~1invoices~1warmUpStepFunctions/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Initiates workflow to warm up inventory transactions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/invoices/warmUpStepFunctions","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/invoices/warmUpStepFunctions","href":"invoices/warmupstepfunctions","openApiOperationId":"warmUpStepFunctions","summary":"Initiates workflow to warm up inventory transactions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Request limit exceeded... please try your request again in a few seconds","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"An internal server error occured.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1invoices~1warmUpStepFunctions/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/warmupstepfunctions"}],"panels":[]}]},"httpPath":"/invoices/warmUpStepFunctions"},{"label":"Creates a new invoice record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoices/processinvoice","routeSlug":"/apis/collect/collect-v1/invoices/processinvoice","metadata":{"seo":{"title":"Creates a new invoice record that does not already exist.","description":"This method will auto-generate an ID and create a new invoice. If an ID is specified for the invoice, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"processInvoice","name":"Creates a new invoice record that does not already exist.","isWebhook":false,"pointer":"/paths/~1invoices~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new invoice record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new invoice. If an ID is specified for the invoice, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1invoices~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Invoice"}},"schemaId":"components/schemas/Invoice","pointer":"/paths/~1invoices~1{tenantId}/post/requestBody","description":"The invoice that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/invoices/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Invoice"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/invoices/{tenantId}","href":"invoices/processinvoice","openApiOperationId":"processInvoice","summary":"Creates a new invoice record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Invoice","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Invoice"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The operation completed successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StepFunctionExecutionToken"}},"schemaId":"components/schemas/StepFunctionExecutionToken","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The invoice you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The invoice could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add invoice based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1invoices~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/StepFunctionExecutionToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StepFunctionExecutionToken"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/processinvoice"}],"panels":[]}]},"httpPath":"/invoices/{tenantId}"},{"label":"Processes an invoice adjustment for the invoice with the specified ID","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoices/adjustinvoiceamountssync","routeSlug":"/apis/collect/collect-v1/invoices/adjustinvoiceamountssync","metadata":{"seo":{"title":"Processes an invoice adjustment for the invoice with the specified ID","description":"This method will start an workflow to adjust an invoice, returning an execution token."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"adjustInvoiceAmountsSync","name":"Processes an invoice adjustment for the invoice with the specified ID","isWebhook":false,"pointer":"/paths/~1invoices~1{tenantId}~1adjustment~1sync~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Processes an invoice adjustment for the invoice with the specified ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will start an workflow to adjust an invoice, returning an execution token."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the invoice to update","required":true}],"pointer":"/paths/~1invoices~1{tenantId}~1adjustment~1sync~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/Invoice"}},"schemaId":"components/schemas/Invoice","pointer":"/paths/~1invoices~1{tenantId}~1adjustment~1sync~1{id}/put/requestBody","description":"The updated invoice record that will be saved"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/invoices/{tenantId}/adjustment/sync/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Invoice"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/invoices/{tenantId}/adjustment/sync/{id}","href":"invoices/adjustinvoiceamountssync","openApiOperationId":"adjustInvoiceAmountsSync","summary":"Processes an invoice adjustment for the invoice with the specified ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Invoice","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Invoice"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The invoice adustment process was successfully started","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StepFunctionExecutionToken"}},"schemaId":"components/schemas/StepFunctionExecutionToken","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The invoice record you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The invoice could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The invoice could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to update invoice based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1invoices~1{tenantId}~1adjustment~1sync~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/StepFunctionExecutionToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StepFunctionExecutionToken"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/adjustinvoiceamountssync"}],"panels":[]}]},"httpPath":"/invoices/{tenantId}/adjustment/sync/{id}"},{"label":"Processes an invoice adjustment for the invoice with the specified ID","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoices/adjustinvoiceamounts","routeSlug":"/apis/collect/collect-v1/invoices/adjustinvoiceamounts","metadata":{"seo":{"title":"Processes an invoice adjustment for the invoice with the specified ID","description":"This method will start an workflow to adjust an invoice, returning an execution token."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"adjustInvoiceAmounts","name":"Processes an invoice adjustment for the invoice with the specified ID","isWebhook":false,"pointer":"/paths/~1invoices~1{tenantId}~1adjustment~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Processes an invoice adjustment for the invoice with the specified ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will start an workflow to adjust an invoice, returning an execution token."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the invoice to update","required":true}],"pointer":"/paths/~1invoices~1{tenantId}~1adjustment~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/Invoice"}},"schemaId":"components/schemas/Invoice","pointer":"/paths/~1invoices~1{tenantId}~1adjustment~1{id}/put/requestBody","description":"The updated invoice record that will be saved"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/invoices/{tenantId}/adjustment/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Invoice"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/invoices/{tenantId}/adjustment/{id}","href":"invoices/adjustinvoiceamounts","openApiOperationId":"adjustInvoiceAmounts","summary":"Processes an invoice adjustment for the invoice with the specified ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Invoice","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Invoice"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The invoice adustment process was successfully started","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StepFunctionExecutionToken"}},"schemaId":"components/schemas/StepFunctionExecutionToken","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The invoice record you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The invoice could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The invoice could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to update invoice based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1invoices~1{tenantId}~1adjustment~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/StepFunctionExecutionToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StepFunctionExecutionToken"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/adjustinvoiceamounts"}],"panels":[]}]},"httpPath":"/invoices/{tenantId}/adjustment/{id}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoices/executebatchoperations","routeSlug":"/apis/collect/collect-v1/invoices/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1invoices~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1invoices~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1invoices~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/invoices/{tenantId}/batch","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/invoices/{tenantId}/batch","href":"invoices/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The invoice could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve invoice based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1invoices~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/executebatchoperations"}],"panels":[]}]},"httpPath":"/invoices/{tenantId}/batch"},{"label":"Returns a list of records with the specified batch_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoices/listinvoicesbybatchid","routeSlug":"/apis/collect/collect-v1/invoices/listinvoicesbybatchid","metadata":{"seo":{"title":"Returns a list of records with the specified batch_id","description":"Returns a list of records with the specified batch_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listInvoicesByBatchId","name":"Returns a list of records with the specified batch_id","isWebhook":false,"pointer":"/paths/~1invoices~1{tenantId}~1batch~1{batch_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified batch_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":"Returns a list of records with the specified batch_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The tenant","required":true},{"name":"batch_id","in":"path","schemaId":"schema_409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The batch_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1invoices~1{tenantId}~1batch~1{batch_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1invoices~1{tenantId}~1batch~1{batch_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/invoices/{tenantId}/batch/{batch_id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"batch_id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/invoices/{tenantId}/batch/{batch_id}","href":"invoices/listinvoicesbybatchid","openApiOperationId":"listInvoicesByBatchId","summary":"Returns a list of records with the specified batch_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListInvoicesResponse"}},"schemaId":"components/schemas/ListInvoicesResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1invoices~1{tenantId}~1batch~1{batch_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListInvoicesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListInvoicesResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/listinvoicesbybatchid"}],"panels":[]}]},"httpPath":"/invoices/{tenantId}/batch/{batch_id}"},{"label":"Returns a list of records with the specified bill_to_contact_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoices/listinvoicesbybilltocontactid","routeSlug":"/apis/collect/collect-v1/invoices/listinvoicesbybilltocontactid","metadata":{"seo":{"title":"Returns a list of records with the specified bill_to_contact_id","description":"Returns a list of records with the specified bill_to_contact_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listInvoicesByBillToContactId","name":"Returns a list of records with the specified bill_to_contact_id","isWebhook":false,"pointer":"/paths/~1invoices~1{tenantId}~1billToContact~1{bill_to_contact_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified bill_to_contact_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":"Returns a list of records with the specified bill_to_contact_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The tenant","required":true},{"name":"bill_to_contact_id","in":"path","schemaId":"schema_409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The bill_to_contact_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1invoices~1{tenantId}~1billToContact~1{bill_to_contact_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"If paging, this allows you to return the next set of results"},{"name":"includeAllInvoices","in":"query","schemaId":"schema_409","description":"if set, all invoices should come through"}],"pointer":"/paths/~1invoices~1{tenantId}~1billToContact~1{bill_to_contact_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/invoices/{tenantId}/billToContact/{bill_to_contact_id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"bill_to_contact_id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"},{"name":"includeAllInvoices","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/invoices/{tenantId}/billToContact/{bill_to_contact_id}","href":"invoices/listinvoicesbybilltocontactid","openApiOperationId":"listInvoicesByBillToContactId","summary":"Returns a list of records with the specified bill_to_contact_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListInvoicesResponse"}},"schemaId":"components/schemas/ListInvoicesResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1invoices~1{tenantId}~1billToContact~1{bill_to_contact_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListInvoicesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListInvoicesResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/listinvoicesbybilltocontactid"}],"panels":[]}]},"httpPath":"/invoices/{tenantId}/billToContact/{bill_to_contact_id}"},{"label":"Returns a list of records with the specified bill_to_organization_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoices/listinvoicesbybilltoorganizationid","routeSlug":"/apis/collect/collect-v1/invoices/listinvoicesbybilltoorganizationid","metadata":{"seo":{"title":"Returns a list of records with the specified bill_to_organization_id","description":"Returns a list of records with the specified bill_to_organization_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listInvoicesByBillToOrganizationId","name":"Returns a list of records with the specified bill_to_organization_id","isWebhook":false,"pointer":"/paths/~1invoices~1{tenantId}~1billToOrganization~1{bill_to_organization_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified bill_to_organization_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":"Returns a list of records with the specified bill_to_organization_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The tenant","required":true},{"name":"bill_to_organization_id","in":"path","schemaId":"schema_409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The bill_to_organization_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1invoices~1{tenantId}~1billToOrganization~1{bill_to_organization_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1invoices~1{tenantId}~1billToOrganization~1{bill_to_organization_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/invoices/{tenantId}/billToOrganization/{bill_to_organization_id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"bill_to_organization_id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/invoices/{tenantId}/billToOrganization/{bill_to_organization_id}","href":"invoices/listinvoicesbybilltoorganizationid","openApiOperationId":"listInvoicesByBillToOrganizationId","summary":"Returns a list of records with the specified bill_to_organization_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListInvoicesResponse"}},"schemaId":"components/schemas/ListInvoicesResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1invoices~1{tenantId}~1billToOrganization~1{bill_to_organization_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListInvoicesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListInvoicesResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/listinvoicesbybilltoorganizationid"}],"panels":[]}]},"httpPath":"/invoices/{tenantId}/billToOrganization/{bill_to_organization_id}"},{"label":"Emails an HTML version of the invoice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoices/emailinvoice","routeSlug":"/apis/collect/collect-v1/invoices/emailinvoice","metadata":{"seo":{"title":"Emails an HTML version of the invoice","description":"Send an email of the invoice"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"emailInvoice","name":"Emails an HTML version of the invoice","isWebhook":false,"pointer":"/paths/~1invoices~1{tenantId}~1email~1{id}/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Emails an HTML version of the invoice","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Send an email of the invoice"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the invoice to return","required":true}],"pointer":"/paths/~1invoices~1{tenantId}~1email~1{id}/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"additionalRecipients","in":"query","schemaId":"schema_409","description":"Others who should receive the email"}],"pointer":"/paths/~1invoices~1{tenantId}~1email~1{id}/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/invoices/{tenantId}/email/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"additionalRecipients","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/invoices/{tenantId}/email/{id}","href":"invoices/emailinvoice","openApiOperationId":"emailInvoice","summary":"Emails an HTML version of the invoice"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The invoice was emailed successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}},"schemaId":"schema_409","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The invoice could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve invoice based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1invoices~1{tenantId}~1email~1{id}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_409","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/emailinvoice"}],"panels":[]}]},"httpPath":"/invoices/{tenantId}/email/{id}"},{"label":"Returns a list of records with the specified number","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoices/listinvoicesbynumber","routeSlug":"/apis/collect/collect-v1/invoices/listinvoicesbynumber","metadata":{"seo":{"title":"Returns a list of records with the specified number","description":"Returns a list of records with the specified number"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listInvoicesByNumber","name":"Returns a list of records with the specified number","isWebhook":false,"pointer":"/paths/~1invoices~1{tenantId}~1number~1{number}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified number","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 records with the specified number"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The tenant","required":true},{"name":"number","in":"path","schemaId":"schema_443","description":"The number to use to for record lookup","required":true}],"pointer":"/paths/~1invoices~1{tenantId}~1number~1{number}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1invoices~1{tenantId}~1number~1{number}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/invoices/{tenantId}/number/{number}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"number","in":"path","required":true,"schemaId":"schema_443"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/invoices/{tenantId}/number/{number}","href":"invoices/listinvoicesbynumber","openApiOperationId":"listInvoicesByNumber","summary":"Returns a list of records with the specified number"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListInvoicesResponse"}},"schemaId":"components/schemas/ListInvoicesResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1invoices~1{tenantId}~1number~1{number}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListInvoicesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListInvoicesResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/listinvoicesbynumber"}],"panels":[]}]},"httpPath":"/invoices/{tenantId}/number/{number}"},{"label":"Returns a list of records with the specified order_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoices/listinvoicesbyorderid","routeSlug":"/apis/collect/collect-v1/invoices/listinvoicesbyorderid","metadata":{"seo":{"title":"Returns a list of records with the specified order_id","description":"Returns a list of records with the specified order_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listInvoicesByOrderId","name":"Returns a list of records with the specified order_id","isWebhook":false,"pointer":"/paths/~1invoices~1{tenantId}~1order~1{order_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified order_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":"Returns a list of records with the specified order_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The tenant","required":true},{"name":"order_id","in":"path","schemaId":"schema_409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The order_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1invoices~1{tenantId}~1order~1{order_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1invoices~1{tenantId}~1order~1{order_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/invoices/{tenantId}/order/{order_id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"order_id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/invoices/{tenantId}/order/{order_id}","href":"invoices/listinvoicesbyorderid","openApiOperationId":"listInvoicesByOrderId","summary":"Returns a list of records with the specified order_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListInvoicesResponse"}},"schemaId":"components/schemas/ListInvoicesResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1invoices~1{tenantId}~1order~1{order_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListInvoicesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListInvoicesResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/listinvoicesbyorderid"}],"panels":[]}]},"httpPath":"/invoices/{tenantId}/order/{order_id}"},{"label":"Returns a list of records with the specified owner","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoices/listinvoicesbyowner","routeSlug":"/apis/collect/collect-v1/invoices/listinvoicesbyowner","metadata":{"seo":{"title":"Returns a list of records with the specified owner","description":"Returns a list of records with the specified owner"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listInvoicesByOwner","name":"Returns a list of records with the specified owner","isWebhook":false,"pointer":"/paths/~1invoices~1{tenantId}~1owner~1{ownerType}~1{ownerId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified owner","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 records with the specified owner"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The tenant","required":true},{"name":"ownerType","in":"path","schemaId":"components/schemas/OwnerType","description":"The type of owner","required":true},{"name":"ownerId","in":"path","schemaId":"schema_409","description":"The ID of the owner","required":true}],"pointer":"/paths/~1invoices~1{tenantId}~1owner~1{ownerType}~1{ownerId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"If paging, this allows you to return the next set of results"},{"name":"includeAllInvoices","in":"query","schemaId":"schema_428","description":"If set, all invoices are returned regardless of balance"}],"pointer":"/paths/~1invoices~1{tenantId}~1owner~1{ownerType}~1{ownerId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/invoices/{tenantId}/owner/{ownerType}/{ownerId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"ownerType","in":"path","required":true,"schemaId":"components/schemas/OwnerType"},{"name":"ownerId","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"},{"name":"includeAllInvoices","in":"query","required":false,"schemaId":"schema_428"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/invoices/{tenantId}/owner/{ownerType}/{ownerId}","href":"invoices/listinvoicesbyowner","openApiOperationId":"listInvoicesByOwner","summary":"Returns a list of records with the specified owner"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListInvoicesResponse"}},"schemaId":"components/schemas/ListInvoicesResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1invoices~1{tenantId}~1owner~1{ownerType}~1{ownerId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListInvoicesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListInvoicesResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/listinvoicesbyowner"}],"panels":[]}]},"httpPath":"/invoices/{tenantId}/owner/{ownerType}/{ownerId}"},{"label":"Gets the URL for public payment of the invoice","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoices/getpublicpaymentlink","routeSlug":"/apis/collect/collect-v1/invoices/getpublicpaymentlink","metadata":{"seo":{"title":"Gets the URL for public payment of the invoice","description":"Returns a link that can be used to share an invoice and payable"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPublicPaymentLink","name":"Gets the URL for public payment of the invoice","isWebhook":false,"pointer":"/paths/~1invoices~1{tenantId}~1paymentLink~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets the URL for public payment of the invoice","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a link that can be used to share an invoice and payable"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the invoice","required":true}],"pointer":"/paths/~1invoices~1{tenantId}~1paymentLink~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/invoices/{tenantId}/paymentLink/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/invoices/{tenantId}/paymentLink/{id}","href":"invoices/getpublicpaymentlink","openApiOperationId":"getPublicPaymentLink","summary":"Gets the URL for public payment of the invoice"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The generation completed successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}},"schemaId":"schema_409","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The invoice could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve invoice based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1invoices~1{tenantId}~1paymentLink~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_409","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/getpublicpaymentlink"}],"panels":[]}]},"httpPath":"/invoices/{tenantId}/paymentLink/{id}"},{"label":"Gets all of the invoices in the system for a given contact.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoices/listinvoicesforportal","routeSlug":"/apis/collect/collect-v1/invoices/listinvoicesforportal","metadata":{"seo":{"title":"Gets all of the invoices in the system for a given contact.","description":"This method will scan all invoices and and return them to the caller for a given contact."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listInvoicesForPortal","name":"Gets all of the invoices in the system for a given contact.","isWebhook":false,"pointer":"/paths/~1invoices~1{tenantId}~1portal~1contact~1{portalContactId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the invoices in the system for a given contact.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all invoices and and return them to the caller for a given contact."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"portalContactId","in":"path","schemaId":"schema_409","description":"The contact to use","required":true}],"pointer":"/paths/~1invoices~1{tenantId}~1portal~1contact~1{portalContactId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"includeAllInvoices","in":"query","schemaId":"schema_428","description":"If set, all invoices are returned regardless of balance"}],"pointer":"/paths/~1invoices~1{tenantId}~1portal~1contact~1{portalContactId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/invoices/{tenantId}/portal/contact/{portalContactId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"portalContactId","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"includeAllInvoices","in":"query","required":false,"schemaId":"schema_428"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/invoices/{tenantId}/portal/contact/{portalContactId}","href":"invoices/listinvoicesforportal","openApiOperationId":"listInvoicesForPortal","summary":"Gets all of the invoices in the system for a given contact."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The operation completed successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListInvoicesResponse"}},"schemaId":"components/schemas/ListInvoicesResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1invoices~1{tenantId}~1portal~1contact~1{portalContactId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListInvoicesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListInvoicesResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/listinvoicesforportal"}],"panels":[]}]},"httpPath":"/invoices/{tenantId}/portal/contact/{portalContactId}"},{"label":"Gets the amount of open invoices for a contact","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoices/getcontactbalance","routeSlug":"/apis/collect/collect-v1/invoices/getcontactbalance","metadata":{"seo":{"title":"Gets the amount of open invoices for a contact","description":"Gets the amount of open invoices for a contact"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getContactBalance","name":"Gets the amount of open invoices for a contact","isWebhook":false,"pointer":"/paths/~1invoices~1{tenantId}~1portal~1contact~1{portalContactId}~1balance/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets the amount of open invoices for a contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets the amount of open invoices for a contact"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed","required":true},{"name":"portalContactId","in":"path","schemaId":"schema_409","description":"The contact","required":true}],"pointer":"/paths/~1invoices~1{tenantId}~1portal~1contact~1{portalContactId}~1balance/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/invoices/{tenantId}/portal/contact/{portalContactId}/balance","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"portalContactId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/invoices/{tenantId}/portal/contact/{portalContactId}/balance","href":"invoices/getcontactbalance","openApiOperationId":"getContactBalance","summary":"Gets the amount of open invoices for a contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The invoice balance was retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OpenBalance"}},"schemaId":"components/schemas/OpenBalance","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The invoice could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve invoice based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1invoices~1{tenantId}~1portal~1contact~1{portalContactId}~1balance/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/OpenBalance","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OpenBalance"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/getcontactbalance"}],"panels":[]}]},"httpPath":"/invoices/{tenantId}/portal/contact/{portalContactId}/balance"},{"label":"Returns a invoice from the system by its ID for a given contact.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoices/getinvoiceforportal","routeSlug":"/apis/collect/collect-v1/invoices/getinvoiceforportal","metadata":{"seo":{"title":"Returns a invoice from the system by its ID for a given contact.","description":"This method will look up a invoice by the specified ID and return it back (for a portal contact)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getInvoiceForPortal","name":"Returns a invoice from the system by its ID for a given contact.","isWebhook":false,"pointer":"/paths/~1invoices~1{tenantId}~1portal~1contact~1{portalContactId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a invoice from the system by its ID for a given contact.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a invoice by the specified ID and return it back (for a portal contact)"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"portalContactId","in":"path","schemaId":"schema_409","description":"The contact to use","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the invoice to return.","required":true}],"pointer":"/paths/~1invoices~1{tenantId}~1portal~1contact~1{portalContactId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_409","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1invoices~1{tenantId}~1portal~1contact~1{portalContactId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/invoices/{tenantId}/portal/contact/{portalContactId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"portalContactId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/invoices/{tenantId}/portal/contact/{portalContactId}/{id}","href":"invoices/getinvoiceforportal","openApiOperationId":"getInvoiceForPortal","summary":"Returns a invoice from the system by its ID for a given contact."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The invoice was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Invoice"}},"schemaId":"components/schemas/Invoice","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The invoice could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve invoice based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1invoices~1{tenantId}~1portal~1contact~1{portalContactId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Invoice","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Invoice"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/getinvoiceforportal"}],"panels":[]}]},"httpPath":"/invoices/{tenantId}/portal/contact/{portalContactId}/{id}"},{"label":"Gets all of the invoices in the system for a given organization.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoices/listinvoicesforportalbyorganization","routeSlug":"/apis/collect/collect-v1/invoices/listinvoicesforportalbyorganization","metadata":{"seo":{"title":"Gets all of the invoices in the system for a given organization.","description":"This method will scan all invoices and and return them to the caller for a given organization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listInvoicesForPortalByOrganization","name":"Gets all of the invoices in the system for a given organization.","isWebhook":false,"pointer":"/paths/~1invoices~1{tenantId}~1portal~1organization~1{portalOrganizationId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the invoices in the system for a given organization.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all invoices and and return them to the caller for a given organization."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"portalOrganizationId","in":"path","schemaId":"schema_409","description":"The organization to use","required":true}],"pointer":"/paths/~1invoices~1{tenantId}~1portal~1organization~1{portalOrganizationId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"includeAllInvoices","in":"query","schemaId":"schema_428","description":"If set, all invoices are returned regardless of balance"}],"pointer":"/paths/~1invoices~1{tenantId}~1portal~1organization~1{portalOrganizationId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/invoices/{tenantId}/portal/organization/{portalOrganizationId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"portalOrganizationId","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"includeAllInvoices","in":"query","required":false,"schemaId":"schema_428"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/invoices/{tenantId}/portal/organization/{portalOrganizationId}","href":"invoices/listinvoicesforportalbyorganization","openApiOperationId":"listInvoicesForPortalByOrganization","summary":"Gets all of the invoices in the system for a given organization."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The oepration completed successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListInvoicesResponse"}},"schemaId":"components/schemas/ListInvoicesResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add organization role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1invoices~1{tenantId}~1portal~1organization~1{portalOrganizationId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListInvoicesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListInvoicesResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/listinvoicesforportalbyorganization"}],"panels":[]}]},"httpPath":"/invoices/{tenantId}/portal/organization/{portalOrganizationId}"},{"label":"Gets the amount of open invoices for a organization","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoices/getorganizationbalance","routeSlug":"/apis/collect/collect-v1/invoices/getorganizationbalance","metadata":{"seo":{"title":"Gets the amount of open invoices for a organization","description":"Gets the amount of open invoices for a organization"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getOrganizationBalance","name":"Gets the amount of open invoices for a organization","isWebhook":false,"pointer":"/paths/~1invoices~1{tenantId}~1portal~1organization~1{portalOrganizationId}~1balance/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets the amount of open invoices for a organization","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets the amount of open invoices for a organization"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed","required":true},{"name":"portalOrganizationId","in":"path","schemaId":"schema_409","description":"The organization","required":true}],"pointer":"/paths/~1invoices~1{tenantId}~1portal~1organization~1{portalOrganizationId}~1balance/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/invoices/{tenantId}/portal/organization/{portalOrganizationId}/balance","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"portalOrganizationId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/invoices/{tenantId}/portal/organization/{portalOrganizationId}/balance","href":"invoices/getorganizationbalance","openApiOperationId":"getOrganizationBalance","summary":"Gets the amount of open invoices for a organization"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The invoice balance was retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OpenBalance"}},"schemaId":"components/schemas/OpenBalance","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The invoice could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve invoice based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1invoices~1{tenantId}~1portal~1organization~1{portalOrganizationId}~1balance/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/OpenBalance","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OpenBalance"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/getorganizationbalance"}],"panels":[]}]},"httpPath":"/invoices/{tenantId}/portal/organization/{portalOrganizationId}/balance"},{"label":"Returns a invoice from the system by its ID for a given organization.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoices/getinvoiceforportal","routeSlug":"/apis/collect/collect-v1/invoices/getinvoiceforportal","metadata":{"seo":{"title":"Returns a invoice from the system by its ID for a given organization.","description":"This method will look up a invoice by the specified ID and return it back (for a portal organization)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getInvoiceForPortal","name":"Returns a invoice from the system by its ID for a given organization.","isWebhook":false,"pointer":"/paths/~1invoices~1{tenantId}~1portal~1organization~1{portalOrganizationId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a invoice from the system by its ID for a given organization.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a invoice by the specified ID and return it back (for a portal organization)"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"portalOrganizationId","in":"path","schemaId":"schema_409","description":"The organization to use","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the invoice to return.","required":true}],"pointer":"/paths/~1invoices~1{tenantId}~1portal~1organization~1{portalOrganizationId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_409","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1invoices~1{tenantId}~1portal~1organization~1{portalOrganizationId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/invoices/{tenantId}/portal/organization/{portalOrganizationId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"portalOrganizationId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/invoices/{tenantId}/portal/organization/{portalOrganizationId}/{id}","href":"invoices/getinvoiceforportal","openApiOperationId":"getInvoiceForPortal","summary":"Returns a invoice from the system by its ID for a given organization."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The invoice was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Invoice"}},"schemaId":"components/schemas/Invoice","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The invoice could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve invoice based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1invoices~1{tenantId}~1portal~1organization~1{portalOrganizationId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Invoice","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Invoice"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/getinvoiceforportal"}],"panels":[]}]},"httpPath":"/invoices/{tenantId}/portal/organization/{portalOrganizationId}/{id}"},{"label":"Sends out a preview of the CRC notification email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoices/previewemail","routeSlug":"/apis/collect/collect-v1/invoices/previewemail","metadata":{"seo":{"title":"Sends out a preview of the CRC notification email","description":"Sends out a preview of the CRC notification email"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"previewEmail","name":"Sends out a preview of the CRC notification email","isWebhook":false,"pointer":"/paths/~1invoices~1{tenantId}~1previewEmail/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sends out a preview of the CRC notification email","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Sends out a preview of the CRC notification email"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The tenant","required":true}],"pointer":"/paths/~1invoices~1{tenantId}~1previewEmail/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PreviewEmailRequest"}},"schemaId":"components/schemas/PreviewEmailRequest","pointer":"/paths/~1invoices~1{tenantId}~1previewEmail/post/requestBody","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The domain_name to use to for record lookup"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/invoices/{tenantId}/previewEmail","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PreviewEmailRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/invoices/{tenantId}/previewEmail","href":"invoices/previewemail","openApiOperationId":"previewEmail","summary":"Sends out a preview of the CRC notification email"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/PreviewEmailRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PreviewEmailRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The record was retrieved successfully","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"Unable to locate any organizations with the specified domain","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1invoices~1{tenantId}~1previewEmail/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/previewemail"}],"panels":[]}]},"httpPath":"/invoices/{tenantId}/previewEmail"},{"label":"Sends out a preview of the notification template","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoices/previewtemplate","routeSlug":"/apis/collect/collect-v1/invoices/previewtemplate","metadata":{"seo":{"title":"Sends out a preview of the notification template","description":"Sends out a preview of the notification template"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"previewTemplate","name":"Sends out a preview of the notification template","isWebhook":false,"pointer":"/paths/~1invoices~1{tenantId}~1previewTemplate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sends out a preview of the notification template","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Sends out a preview of the notification template"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The tenant","required":true}],"pointer":"/paths/~1invoices~1{tenantId}~1previewTemplate/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PreviewTemplateRequest"}},"schemaId":"components/schemas/PreviewTemplateRequest","pointer":"/paths/~1invoices~1{tenantId}~1previewTemplate/post/requestBody","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The domain_name to use to for record lookup"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/invoices/{tenantId}/previewTemplate","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PreviewTemplateRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/invoices/{tenantId}/previewTemplate","href":"invoices/previewtemplate","openApiOperationId":"previewTemplate","summary":"Sends out a preview of the notification template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/PreviewTemplateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PreviewTemplateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The record was retrieved successfully","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"Unable to locate any organizations with the specified domain","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1invoices~1{tenantId}~1previewTemplate/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/previewtemplate"}],"panels":[]}]},"httpPath":"/invoices/{tenantId}/previewTemplate"},{"label":"Generates a PDF and returns the public link for download","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoices/downloadpdf","routeSlug":"/apis/collect/collect-v1/invoices/downloadpdf","metadata":{"seo":{"title":"Generates a PDF and returns the public link for download","description":"Generates a PDF and returns the public link for download"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadPdf","name":"Generates a PDF and returns the public link for download","isWebhook":false,"pointer":"/paths/~1invoices~1{tenantId}~1print~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Generates a PDF and returns the public link for download","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Generates a PDF and returns the public link for download"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the invoice to return","required":true}],"pointer":"/paths/~1invoices~1{tenantId}~1print~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"downloadAsHtml","in":"query","schemaId":"schema_428","description":"If true, return the receipt as HTML"}],"pointer":"/paths/~1invoices~1{tenantId}~1print~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/invoices/{tenantId}/print/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"downloadAsHtml","in":"query","required":false,"schemaId":"schema_428"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/invoices/{tenantId}/print/{id}","href":"invoices/downloadpdf","openApiOperationId":"downloadPdf","summary":"Generates a PDF and returns the public link for download"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The invoice was downloaded successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}},"schemaId":"schema_409","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The invoice could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve invoice based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1invoices~1{tenantId}~1print~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_409","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/downloadpdf"}],"panels":[]}]},"httpPath":"/invoices/{tenantId}/print/{id}"},{"label":"Gets Public Invoice information","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoices/getinvoicepublicly","routeSlug":"/apis/collect/collect-v1/invoices/getinvoicepublicly","metadata":{"seo":{"title":"Gets Public Invoice information","description":"Public endpoint that allows for retrieval of invoice information, provided the accurate sharing secret is supplied"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getInvoicePublicly","name":"Gets Public Invoice information","isWebhook":false,"pointer":"/paths/~1invoices~1{tenantId}~1public~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets Public Invoice information","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Public endpoint that allows for retrieval of invoice information, provided the accurate sharing secret is supplied"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the invoice","required":true}],"pointer":"/paths/~1invoices~1{tenantId}~1public~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sharing_secret","in":"query","schemaId":"schema_409","description":"The sharing secret of hte invoice","required":true}],"pointer":"/paths/~1invoices~1{tenantId}~1public~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/invoices/{tenantId}/public/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"sharing_secret","in":"query","required":true,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/invoices/{tenantId}/public/{id}","href":"invoices/getinvoicepublicly","openApiOperationId":"getInvoicePublicly","summary":"Gets Public Invoice information"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The generation completed successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PublicInvoiceInfo"}},"schemaId":"components/schemas/PublicInvoiceInfo","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The invoice could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve invoice based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1invoices~1{tenantId}~1public~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PublicInvoiceInfo","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PublicInvoiceInfo"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/getinvoicepublicly"}],"panels":[]}]},"httpPath":"/invoices/{tenantId}/public/{id}"},{"label":"Finds all legacy invoices with an open balance and regenerates them","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoices/regeneratelegacyopeninvoices","routeSlug":"/apis/collect/collect-v1/invoices/regeneratelegacyopeninvoices","metadata":{"seo":{"title":"Finds all legacy invoices with an open balance and regenerates them","description":"Finds all legacy invoices with an open balance and regenerates them"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"regenerateLegacyOpenInvoices","name":"Finds all legacy invoices with an open balance and regenerates them","isWebhook":false,"pointer":"/paths/~1invoices~1{tenantId}~1regenerateOpenInvoices~1{business_unit_id}/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Finds all legacy invoices with an open balance and regenerates them","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Finds all legacy invoices with an open balance and regenerates them"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed","required":true},{"name":"business_unit_id","in":"path","schemaId":"schema_409","description":"The business unit","required":true}],"pointer":"/paths/~1invoices~1{tenantId}~1regenerateOpenInvoices~1{business_unit_id}/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/invoices/{tenantId}/regenerateOpenInvoices/{business_unit_id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"business_unit_id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/invoices/{tenantId}/regenerateOpenInvoices/{business_unit_id}","href":"invoices/regeneratelegacyopeninvoices","openApiOperationId":"regenerateLegacyOpenInvoices","summary":"Finds all legacy invoices with an open balance and regenerates them"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The generation completed successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RegenerateLegacyOpenInvoiceResult"}},"schemaId":"components/schemas/RegenerateLegacyOpenInvoiceResult","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The invoice could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve invoice based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1invoices~1{tenantId}~1regenerateOpenInvoices~1{business_unit_id}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RegenerateLegacyOpenInvoiceResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RegenerateLegacyOpenInvoiceResult"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/regeneratelegacyopeninvoices"}],"panels":[]}]},"httpPath":"/invoices/{tenantId}/regenerateOpenInvoices/{business_unit_id}"},{"label":"Generates a PDF and returns the public link for download","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoices/renderinvoiceemail","routeSlug":"/apis/collect/collect-v1/invoices/renderinvoiceemail","metadata":{"seo":{"title":"Generates a PDF and returns the public link for download","description":"Generates a PDF and returns the public link for download"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"renderInvoiceEmail","name":"Generates a PDF and returns the public link for download","isWebhook":false,"pointer":"/paths/~1invoices~1{tenantId}~1renderEmail~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Generates a PDF and returns the public link for download","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Generates a PDF and returns the public link for download"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the invoice to return","required":true}],"pointer":"/paths/~1invoices~1{tenantId}~1renderEmail~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/invoices/{tenantId}/renderEmail/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/invoices/{tenantId}/renderEmail/{id}","href":"invoices/renderinvoiceemail","openApiOperationId":"renderInvoiceEmail","summary":"Generates a PDF and returns the public link for download"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The invoice was downloaded successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_415"}},"schemaId":"schema_415","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The invoice could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve invoice based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1invoices~1{tenantId}~1renderEmail~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_415","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_415"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/renderinvoiceemail"}],"panels":[]}]},"httpPath":"/invoices/{tenantId}/renderEmail/{id}"},{"label":"Searches for invoices using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoices/searchforinvoices","routeSlug":"/apis/collect/collect-v1/invoices/searchforinvoices","metadata":{"seo":{"title":"Searches for invoices using predefined parameters","description":"Searches for invoices using predefined parameters"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchForInvoices","name":"Searches for invoices using predefined parameters","isWebhook":false,"pointer":"/paths/~1invoices~1{tenantId}~1search/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Searches for invoices using predefined parameters","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Searches for invoices using predefined parameters"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1invoices~1{tenantId}~1search/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"The start key for the search, for paging support"},{"name":"fieldsToReturn","in":"query","schemaId":"schema_409","description":"  The fields that you want to retrieve; if omitted, the entire object is returned"}],"pointer":"/paths/~1invoices~1{tenantId}~1search/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/InvoiceSearchParameters"}},"schemaId":"components/schemas/InvoiceSearchParameters","pointer":"/paths/~1invoices~1{tenantId}~1search/post/requestBody","description":"The invoice that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/invoices/{tenantId}/search","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"},{"name":"fieldsToReturn","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/InvoiceSearchParameters"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/invoices/{tenantId}/search","href":"invoices/searchforinvoices","openApiOperationId":"searchForInvoices","summary":"Searches for invoices using predefined parameters"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/InvoiceSearchParameters","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/InvoiceSearchParameters"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The invoice search was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedInvoiceSearchResults"}},"schemaId":"components/schemas/PagedInvoiceSearchResults","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The invoice you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The invoice could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add invoice based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1invoices~1{tenantId}~1search/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PagedInvoiceSearchResults","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedInvoiceSearchResults"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/searchforinvoices"}],"panels":[]}]},"httpPath":"/invoices/{tenantId}/search"},{"label":"This is a synchronous processing and should be used exclusively. The old way (via step function) is deprecated.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoices/processinvoicesync","routeSlug":"/apis/collect/collect-v1/invoices/processinvoicesync","metadata":{"seo":{"title":"This is a synchronous processing and should be used exclusively. The old way (via step function) is deprecated.","description":"Processes an invoice"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"processInvoiceSync","name":"This is a synchronous processing and should be used exclusively. The old way (via step function) is deprecated.","isWebhook":false,"pointer":"/paths/~1invoices~1{tenantId}~1sync/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"This is a synchronous processing and should be used exclusively. The old way (via step function) is deprecated.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Processes an invoice"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1invoices~1{tenantId}~1sync/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Invoice"}},"schemaId":"components/schemas/Invoice","pointer":"/paths/~1invoices~1{tenantId}~1sync/post/requestBody","description":"The invoice that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/invoices/{tenantId}/sync","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Invoice"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/invoices/{tenantId}/sync","href":"invoices/processinvoicesync","openApiOperationId":"processInvoiceSync","summary":"This is a synchronous processing and should be used exclusively. The old way (via step function) is deprecated."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Invoice","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Invoice"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The operation completed successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Invoice"}},"schemaId":"components/schemas/Invoice","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The invoice you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The invoice could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add invoice based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1invoices~1{tenantId}~1sync/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Invoice","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Invoice"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/processinvoicesync"}],"panels":[]}]},"httpPath":"/invoices/{tenantId}/sync"},{"label":"Returns a invoice from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoices/deleteinvoice","routeSlug":"/apis/collect/collect-v1/invoices/deleteinvoice","metadata":{"seo":{"title":"Returns a invoice from the system by its ID.","description":"This method will delete a invoice with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteInvoice","name":"Returns a invoice from the system by its ID.","isWebhook":false,"pointer":"/paths/~1invoices~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a invoice from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a invoice with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the invoice to delete.","required":true}],"pointer":"/paths/~1invoices~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/invoices/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/invoices/{tenantId}/{id}","href":"invoices/deleteinvoice","openApiOperationId":"deleteInvoice","summary":"Returns a invoice from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The invoice was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}},"schemaId":"schema_409","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The invoice could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The invoice could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to delete invoice based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1invoices~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_409","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/deleteinvoice"}],"panels":[]}]},"httpPath":"/invoices/{tenantId}/{id}"},{"label":"Returns a invoice from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoices/getinvoice","routeSlug":"/apis/collect/collect-v1/invoices/getinvoice","metadata":{"seo":{"title":"Returns a invoice from the system by its ID.","description":"This method will look up a invoice by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getInvoice","name":"Returns a invoice from the system by its ID.","isWebhook":false,"pointer":"/paths/~1invoices~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a invoice from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a invoice by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the invoice to return.","required":true}],"pointer":"/paths/~1invoices~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_409","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1invoices~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/invoices/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/invoices/{tenantId}/{id}","href":"invoices/getinvoice","openApiOperationId":"getInvoice","summary":"Returns a invoice from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The invoice was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Invoice"}},"schemaId":"components/schemas/Invoice","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The invoice could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve invoice based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1invoices~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Invoice","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Invoice"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/getinvoice"}],"panels":[]}]},"httpPath":"/invoices/{tenantId}/{id}"},{"label":"Partially updates a invoice with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoices/patchinvoice","routeSlug":"/apis/collect/collect-v1/invoices/patchinvoice","metadata":{"seo":{"title":"Partially updates a invoice with the specified ID.","description":"This method will patch an existing invoice with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchInvoice","name":"Partially updates a invoice with the specified ID.","isWebhook":false,"pointer":"/paths/~1invoices~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a invoice with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing invoice with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the invoice to patch.","required":true}],"pointer":"/paths/~1invoices~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"schemaId":"schema_412","pointer":"/paths/~1invoices~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/invoices/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_412"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/invoices/{tenantId}/{id}","href":"invoices/patchinvoice","openApiOperationId":"patchInvoice","summary":"Partially updates a invoice with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"schema_412","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The invoice was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Invoice"}},"schemaId":"components/schemas/Invoice","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The invoice could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The invoice could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve invoice based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1invoices~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Invoice","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Invoice"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/patchinvoice"}],"panels":[]}]},"httpPath":"/invoices/{tenantId}/{id}"},{"label":"Updates a invoice with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoices/updateinvoice","routeSlug":"/apis/collect/collect-v1/invoices/updateinvoice","metadata":{"seo":{"title":"Updates a invoice with the specified ID.","description":"This method will update an existing invoice with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateInvoice","name":"Updates a invoice with the specified ID.","isWebhook":false,"pointer":"/paths/~1invoices~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a invoice with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing invoice with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the invoice to update.","required":true}],"pointer":"/paths/~1invoices~1{tenantId}~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/Invoice"}},"schemaId":"components/schemas/Invoice","pointer":"/paths/~1invoices~1{tenantId}~1{id}/put/requestBody","description":"The updated invoice that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/invoices/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Invoice"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/invoices/{tenantId}/{id}","href":"invoices/updateinvoice","openApiOperationId":"updateInvoice","summary":"Updates a invoice with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Invoice","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Invoice"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The invoice was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Invoice"}},"schemaId":"components/schemas/Invoice","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The invoice supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The invoice could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The invoice could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve invoice based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1invoices~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Invoice","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Invoice"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invoices/updateinvoice"}],"panels":[]}]},"httpPath":"/invoices/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Invoices"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Invoices","showPageActions":true},{"nodeType":"markdoc","content":"Invoices"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/invoices/defaultTemplate/invoice","summary":"Returns the default invoice template","prefix":{"name":"get","color":"get"},"badges":[],"link":"/invoices/getdefaultinvoicetemplate","deprecated":false},{"title":"/invoices/defaultTemplateAndEmail/invoice","summary":"Returns the default invoice template","prefix":{"name":"get","color":"get"},"badges":[],"link":"/invoices/getdefaultinvoicetemplateandemail","deprecated":false},{"title":"/invoices/warmUpStepFunctions","summary":"Initiates workflow to warm up inventory transactions","prefix":{"name":"post","color":"post"},"badges":[],"link":"/invoices/warmupstepfunctions","deprecated":false},{"title":"/invoices/{tenantId}","summary":"Creates a new invoice record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/invoices/processinvoice","deprecated":false},{"title":"/invoices/{tenantId}/adjustment/sync/{id}","summary":"Processes an invoice adjustment for the invoice with the specified ID","prefix":{"name":"put","color":"put"},"badges":[],"link":"/invoices/adjustinvoiceamountssync","deprecated":false},{"title":"/invoices/{tenantId}/adjustment/{id}","summary":"Processes an invoice adjustment for the invoice with the specified ID","prefix":{"name":"put","color":"put"},"badges":[],"link":"/invoices/adjustinvoiceamounts","deprecated":false},{"title":"/invoices/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/invoices/executebatchoperations","deprecated":false},{"title":"/invoices/{tenantId}/batch/{batch_id}","summary":"Returns a list of records with the specified batch_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/invoices/listinvoicesbybatchid","deprecated":false},{"title":"/invoices/{tenantId}/billToContact/{bill_to_contact_id}","summary":"Returns a list of records with the specified bill_to_contact_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/invoices/listinvoicesbybilltocontactid","deprecated":false},{"title":"/invoices/{tenantId}/billToOrganization/{bill_to_organization_id}","summary":"Returns a list of records with the specified bill_to_organization_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/invoices/listinvoicesbybilltoorganizationid","deprecated":false},{"title":"/invoices/{tenantId}/email/{id}","summary":"Emails an HTML version of the invoice","prefix":{"name":"post","color":"post"},"badges":[],"link":"/invoices/emailinvoice","deprecated":false},{"title":"/invoices/{tenantId}/number/{number}","summary":"Returns a list of records with the specified number","prefix":{"name":"get","color":"get"},"badges":[],"link":"/invoices/listinvoicesbynumber","deprecated":false},{"title":"/invoices/{tenantId}/order/{order_id}","summary":"Returns a list of records with the specified order_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/invoices/listinvoicesbyorderid","deprecated":false},{"title":"/invoices/{tenantId}/owner/{ownerType}/{ownerId}","summary":"Returns a list of records with the specified owner","prefix":{"name":"get","color":"get"},"badges":[],"link":"/invoices/listinvoicesbyowner","deprecated":false},{"title":"/invoices/{tenantId}/paymentLink/{id}","summary":"Gets the URL for public payment of the invoice","prefix":{"name":"get","color":"get"},"badges":[],"link":"/invoices/getpublicpaymentlink","deprecated":false},{"title":"/invoices/{tenantId}/portal/contact/{portalContactId}","summary":"Gets all of the invoices in the system for a given contact.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/invoices/listinvoicesforportal","deprecated":false},{"title":"/invoices/{tenantId}/portal/contact/{portalContactId}/balance","summary":"Gets the amount of open invoices for a contact","prefix":{"name":"get","color":"get"},"badges":[],"link":"/invoices/getcontactbalance","deprecated":false},{"title":"/invoices/{tenantId}/portal/contact/{portalContactId}/{id}","summary":"Returns a invoice from the system by its ID for a given contact.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/invoices/getinvoiceforportal","deprecated":false},{"title":"/invoices/{tenantId}/portal/organization/{portalOrganizationId}","summary":"Gets all of the invoices in the system for a given organization.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/invoices/listinvoicesforportalbyorganization","deprecated":false},{"title":"/invoices/{tenantId}/portal/organization/{portalOrganizationId}/balance","summary":"Gets the amount of open invoices for a organization","prefix":{"name":"get","color":"get"},"badges":[],"link":"/invoices/getorganizationbalance","deprecated":false},{"title":"/invoices/{tenantId}/portal/organization/{portalOrganizationId}/{id}","summary":"Returns a invoice from the system by its ID for a given organization.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/invoices/getinvoiceforportal","deprecated":false},{"title":"/invoices/{tenantId}/previewEmail","summary":"Sends out a preview of the CRC notification email","prefix":{"name":"post","color":"post"},"badges":[],"link":"/invoices/previewemail","deprecated":false},{"title":"/invoices/{tenantId}/previewTemplate","summary":"Sends out a preview of the notification template","prefix":{"name":"post","color":"post"},"badges":[],"link":"/invoices/previewtemplate","deprecated":false},{"title":"/invoices/{tenantId}/print/{id}","summary":"Generates a PDF and returns the public link for download","prefix":{"name":"get","color":"get"},"badges":[],"link":"/invoices/downloadpdf","deprecated":false},{"title":"/invoices/{tenantId}/public/{id}","summary":"Gets Public Invoice information","prefix":{"name":"get","color":"get"},"badges":[],"link":"/invoices/getinvoicepublicly","deprecated":false},{"title":"/invoices/{tenantId}/regenerateOpenInvoices/{business_unit_id}","summary":"Finds all legacy invoices with an open balance and regenerates them","prefix":{"name":"post","color":"post"},"badges":[],"link":"/invoices/regeneratelegacyopeninvoices","deprecated":false},{"title":"/invoices/{tenantId}/renderEmail/{id}","summary":"Generates a PDF and returns the public link for download","prefix":{"name":"get","color":"get"},"badges":[],"link":"/invoices/renderinvoiceemail","deprecated":false},{"title":"/invoices/{tenantId}/search","summary":"Searches for invoices using predefined parameters","prefix":{"name":"post","color":"post"},"badges":[],"link":"/invoices/searchforinvoices","deprecated":false},{"title":"/invoices/{tenantId}/sync","summary":"This is a synchronous processing and should be used exclusively. The old way (via step function) is deprecated.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/invoices/processinvoicesync","deprecated":false},{"title":"/invoices/{tenantId}/{id}","summary":"Returns a invoice from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/invoices/deleteinvoice","deprecated":false},{"title":"/invoices/{tenantId}/{id}","summary":"Returns a invoice from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/invoices/getinvoice","deprecated":false},{"title":"/invoices/{tenantId}/{id}","summary":"Partially updates a invoice with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/invoices/patchinvoice","deprecated":false},{"title":"/invoices/{tenantId}/{id}","summary":"Updates a invoice with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/invoices/updateinvoice","deprecated":false}]}]}]}]}},{"type":"group","label":"Late Fee Rules","link":"/apis/collect/collect-v1/late-fee-rules","routeSlug":"/apis/collect/collect-v1/late-fee-rules","items":[{"label":"Gets all of the late fee rules in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/late-fee-rules/listlatefeerules","routeSlug":"/apis/collect/collect-v1/late-fee-rules/listlatefeerules","metadata":{"seo":{"title":"Gets all of the late fee rules in the system.","description":"This method will scan all late fee rules and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listLateFeeRules","name":"Gets all of the late fee rules in the system.","isWebhook":false,"pointer":"/paths/~1lateFeeRules~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the late fee rules in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all late fee rules and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1lateFeeRules~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1lateFeeRules~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/lateFeeRules/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/lateFeeRules/{tenantId}","href":"late-fee-rules/listlatefeerules","openApiOperationId":"listLateFeeRules","summary":"Gets all of the late fee rules in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The late fee ruleswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_444"}},"schemaId":"schema_444","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1lateFeeRules~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_444","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_444"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/late-fee-rules/listlatefeerules"}],"panels":[]}]},"httpPath":"/lateFeeRules/{tenantId}"},{"label":"Creates a new late fee rule record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/late-fee-rules/createlatefeerule","routeSlug":"/apis/collect/collect-v1/late-fee-rules/createlatefeerule","metadata":{"seo":{"title":"Creates a new late fee rule record that does not already exist.","description":"This method will auto-generate an ID and create a new late fee rule. If an ID is specified for the late fee rule, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createLateFeeRule","name":"Creates a new late fee rule record that does not already exist.","isWebhook":false,"pointer":"/paths/~1lateFeeRules~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new late fee rule record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new late fee rule. If an ID is specified for the late fee rule, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1lateFeeRules~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LateFeeRule"}},"schemaId":"components/schemas/LateFeeRule","pointer":"/paths/~1lateFeeRules~1{tenantId}/post/requestBody","description":"The late fee rule that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/lateFeeRules/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/LateFeeRule"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/lateFeeRules/{tenantId}","href":"late-fee-rules/createlatefeerule","openApiOperationId":"createLateFeeRule","summary":"Creates a new late fee rule record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/LateFeeRule","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LateFeeRule"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The late fee rule was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LateFeeRule"}},"schemaId":"components/schemas/LateFeeRule","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The late fee rule you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The late fee rule could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add late fee rule based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1lateFeeRules~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/LateFeeRule","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LateFeeRule"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/late-fee-rules/createlatefeerule"}],"panels":[]}]},"httpPath":"/lateFeeRules/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/late-fee-rules/executebatchoperations","routeSlug":"/apis/collect/collect-v1/late-fee-rules/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1lateFeeRules~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1lateFeeRules~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1lateFeeRules~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/lateFeeRules/{tenantId}/batch","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/lateFeeRules/{tenantId}/batch","href":"late-fee-rules/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The late fee rule could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve late fee rule based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1lateFeeRules~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/late-fee-rules/executebatchoperations"}],"panels":[]}]},"httpPath":"/lateFeeRules/{tenantId}/batch"},{"label":"Returns a late fee rule from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/late-fee-rules/deletelatefeerule","routeSlug":"/apis/collect/collect-v1/late-fee-rules/deletelatefeerule","metadata":{"seo":{"title":"Returns a late fee rule from the system by its ID.","description":"This method will delete a late fee rule with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteLateFeeRule","name":"Returns a late fee rule from the system by its ID.","isWebhook":false,"pointer":"/paths/~1lateFeeRules~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a late fee rule from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a late fee rule with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the late fee rule to delete.","required":true}],"pointer":"/paths/~1lateFeeRules~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/lateFeeRules/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/lateFeeRules/{tenantId}/{id}","href":"late-fee-rules/deletelatefeerule","openApiOperationId":"deleteLateFeeRule","summary":"Returns a late fee rule from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The late fee rule was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}},"schemaId":"schema_409","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The late fee rule could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The late fee rule could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to delete late fee rule based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1lateFeeRules~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_409","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/late-fee-rules/deletelatefeerule"}],"panels":[]}]},"httpPath":"/lateFeeRules/{tenantId}/{id}"},{"label":"Returns a late fee rule from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/late-fee-rules/getlatefeerule","routeSlug":"/apis/collect/collect-v1/late-fee-rules/getlatefeerule","metadata":{"seo":{"title":"Returns a late fee rule from the system by its ID.","description":"This method will look up a late fee rule by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getLateFeeRule","name":"Returns a late fee rule from the system by its ID.","isWebhook":false,"pointer":"/paths/~1lateFeeRules~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a late fee rule from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a late fee rule by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the late fee rule to return.","required":true}],"pointer":"/paths/~1lateFeeRules~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_409","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1lateFeeRules~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/lateFeeRules/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/lateFeeRules/{tenantId}/{id}","href":"late-fee-rules/getlatefeerule","openApiOperationId":"getLateFeeRule","summary":"Returns a late fee rule from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The late fee rule was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LateFeeRule"}},"schemaId":"components/schemas/LateFeeRule","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The late fee rule could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve late fee rule based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1lateFeeRules~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/LateFeeRule","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LateFeeRule"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/late-fee-rules/getlatefeerule"}],"panels":[]}]},"httpPath":"/lateFeeRules/{tenantId}/{id}"},{"label":"Partially updates a late fee rule with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/late-fee-rules/patchlatefeerule","routeSlug":"/apis/collect/collect-v1/late-fee-rules/patchlatefeerule","metadata":{"seo":{"title":"Partially updates a late fee rule with the specified ID.","description":"This method will patch an existing late fee rule with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchLateFeeRule","name":"Partially updates a late fee rule with the specified ID.","isWebhook":false,"pointer":"/paths/~1lateFeeRules~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a late fee rule with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing late fee rule with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the late fee rule to patch.","required":true}],"pointer":"/paths/~1lateFeeRules~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"schemaId":"schema_412","pointer":"/paths/~1lateFeeRules~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/lateFeeRules/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_412"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/lateFeeRules/{tenantId}/{id}","href":"late-fee-rules/patchlatefeerule","openApiOperationId":"patchLateFeeRule","summary":"Partially updates a late fee rule with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"schema_412","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The late fee rule was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LateFeeRule"}},"schemaId":"components/schemas/LateFeeRule","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The late fee rule could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The late fee rule could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve late fee rule based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1lateFeeRules~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/LateFeeRule","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LateFeeRule"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/late-fee-rules/patchlatefeerule"}],"panels":[]}]},"httpPath":"/lateFeeRules/{tenantId}/{id}"},{"label":"Updates a late fee rule with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/late-fee-rules/updatelatefeerule","routeSlug":"/apis/collect/collect-v1/late-fee-rules/updatelatefeerule","metadata":{"seo":{"title":"Updates a late fee rule with the specified ID.","description":"This method will update an existing late fee rule with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateLateFeeRule","name":"Updates a late fee rule with the specified ID.","isWebhook":false,"pointer":"/paths/~1lateFeeRules~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a late fee rule with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing late fee rule with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the late fee rule to update.","required":true}],"pointer":"/paths/~1lateFeeRules~1{tenantId}~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/LateFeeRule"}},"schemaId":"components/schemas/LateFeeRule","pointer":"/paths/~1lateFeeRules~1{tenantId}~1{id}/put/requestBody","description":"The updated late fee rule that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/lateFeeRules/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/LateFeeRule"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/lateFeeRules/{tenantId}/{id}","href":"late-fee-rules/updatelatefeerule","openApiOperationId":"updateLateFeeRule","summary":"Updates a late fee rule with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/LateFeeRule","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LateFeeRule"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The late fee rule was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LateFeeRule"}},"schemaId":"components/schemas/LateFeeRule","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The late fee rule supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The late fee rule could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The late fee rule could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve late fee rule based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1lateFeeRules~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/LateFeeRule","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LateFeeRule"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/late-fee-rules/updatelatefeerule"}],"panels":[]}]},"httpPath":"/lateFeeRules/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Late Fee Rules"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Late Fee Rules","showPageActions":true},{"nodeType":"markdoc","content":"Late Fee Rules"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/lateFeeRules/{tenantId}","summary":"Gets all of the late fee rules in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/late-fee-rules/listlatefeerules","deprecated":false},{"title":"/lateFeeRules/{tenantId}","summary":"Creates a new late fee rule record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/late-fee-rules/createlatefeerule","deprecated":false},{"title":"/lateFeeRules/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/late-fee-rules/executebatchoperations","deprecated":false},{"title":"/lateFeeRules/{tenantId}/{id}","summary":"Returns a late fee rule from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/late-fee-rules/deletelatefeerule","deprecated":false},{"title":"/lateFeeRules/{tenantId}/{id}","summary":"Returns a late fee rule from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/late-fee-rules/getlatefeerule","deprecated":false},{"title":"/lateFeeRules/{tenantId}/{id}","summary":"Partially updates a late fee rule with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/late-fee-rules/patchlatefeerule","deprecated":false},{"title":"/lateFeeRules/{tenantId}/{id}","summary":"Updates a late fee rule with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/late-fee-rules/updatelatefeerule","deprecated":false}]}]}]}]}},{"type":"group","label":"Late Fees","link":"/apis/collect/collect-v1/late-fees","routeSlug":"/apis/collect/collect-v1/late-fees","items":[{"label":"Gets all of the late fees in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/late-fees/listlatefees","routeSlug":"/apis/collect/collect-v1/late-fees/listlatefees","metadata":{"seo":{"title":"Gets all of the late fees in the system.","description":"This method will scan all late fees and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listLateFees","name":"Gets all of the late fees in the system.","isWebhook":false,"pointer":"/paths/~1lateFees~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the late fees in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all late fees and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1lateFees~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1lateFees~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/lateFees/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/lateFees/{tenantId}","href":"late-fees/listlatefees","openApiOperationId":"listLateFees","summary":"Gets all of the late fees in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The late feeswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_445"}},"schemaId":"schema_445","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1lateFees~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_445","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_445"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/late-fees/listlatefees"}],"panels":[]}]},"httpPath":"/lateFees/{tenantId}"},{"label":"Creates a new late fee record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/late-fees/createlatefee","routeSlug":"/apis/collect/collect-v1/late-fees/createlatefee","metadata":{"seo":{"title":"Creates a new late fee record that does not already exist.","description":"This method will auto-generate an ID and create a new late fee. If an ID is specified for the late fee, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createLateFee","name":"Creates a new late fee record that does not already exist.","isWebhook":false,"pointer":"/paths/~1lateFees~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new late fee record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new late fee. If an ID is specified for the late fee, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1lateFees~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LateFee"}},"schemaId":"components/schemas/LateFee","pointer":"/paths/~1lateFees~1{tenantId}/post/requestBody","description":"The late fee that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/lateFees/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/LateFee"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/lateFees/{tenantId}","href":"late-fees/createlatefee","openApiOperationId":"createLateFee","summary":"Creates a new late fee record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/LateFee","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LateFee"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The late fee was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LateFee"}},"schemaId":"components/schemas/LateFee","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The late fee you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The late fee could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add late fee based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1lateFees~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/LateFee","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LateFee"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/late-fees/createlatefee"}],"panels":[]}]},"httpPath":"/lateFees/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/late-fees/executebatchoperations","routeSlug":"/apis/collect/collect-v1/late-fees/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1lateFees~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1lateFees~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1lateFees~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/lateFees/{tenantId}/batch","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/lateFees/{tenantId}/batch","href":"late-fees/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The late fee could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve late fee based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1lateFees~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/late-fees/executebatchoperations"}],"panels":[]}]},"httpPath":"/lateFees/{tenantId}/batch"},{"label":"Returns a late fee from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/late-fees/deletelatefee","routeSlug":"/apis/collect/collect-v1/late-fees/deletelatefee","metadata":{"seo":{"title":"Returns a late fee from the system by its ID.","description":"This method will delete a late fee with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteLateFee","name":"Returns a late fee from the system by its ID.","isWebhook":false,"pointer":"/paths/~1lateFees~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a late fee from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a late fee with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the late fee to delete.","required":true}],"pointer":"/paths/~1lateFees~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/lateFees/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/lateFees/{tenantId}/{id}","href":"late-fees/deletelatefee","openApiOperationId":"deleteLateFee","summary":"Returns a late fee from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The late fee was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}},"schemaId":"schema_409","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The late fee could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The late fee could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to delete late fee based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1lateFees~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_409","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/late-fees/deletelatefee"}],"panels":[]}]},"httpPath":"/lateFees/{tenantId}/{id}"},{"label":"Returns a late fee from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/late-fees/getlatefee","routeSlug":"/apis/collect/collect-v1/late-fees/getlatefee","metadata":{"seo":{"title":"Returns a late fee from the system by its ID.","description":"This method will look up a late fee by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getLateFee","name":"Returns a late fee from the system by its ID.","isWebhook":false,"pointer":"/paths/~1lateFees~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a late fee from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a late fee by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the late fee to return.","required":true}],"pointer":"/paths/~1lateFees~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_409","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1lateFees~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/lateFees/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/lateFees/{tenantId}/{id}","href":"late-fees/getlatefee","openApiOperationId":"getLateFee","summary":"Returns a late fee from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The late fee was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LateFee"}},"schemaId":"components/schemas/LateFee","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The late fee could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve late fee based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1lateFees~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/LateFee","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LateFee"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/late-fees/getlatefee"}],"panels":[]}]},"httpPath":"/lateFees/{tenantId}/{id}"},{"label":"Partially updates a late fee with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/late-fees/patchlatefee","routeSlug":"/apis/collect/collect-v1/late-fees/patchlatefee","metadata":{"seo":{"title":"Partially updates a late fee with the specified ID.","description":"This method will patch an existing late fee with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchLateFee","name":"Partially updates a late fee with the specified ID.","isWebhook":false,"pointer":"/paths/~1lateFees~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a late fee with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing late fee with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the late fee to patch.","required":true}],"pointer":"/paths/~1lateFees~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"schemaId":"schema_412","pointer":"/paths/~1lateFees~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/lateFees/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_412"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/lateFees/{tenantId}/{id}","href":"late-fees/patchlatefee","openApiOperationId":"patchLateFee","summary":"Partially updates a late fee with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"schema_412","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The late fee was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LateFee"}},"schemaId":"components/schemas/LateFee","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The late fee could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The late fee could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve late fee based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1lateFees~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/LateFee","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LateFee"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/late-fees/patchlatefee"}],"panels":[]}]},"httpPath":"/lateFees/{tenantId}/{id}"},{"label":"Updates a late fee with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/late-fees/updatelatefee","routeSlug":"/apis/collect/collect-v1/late-fees/updatelatefee","metadata":{"seo":{"title":"Updates a late fee with the specified ID.","description":"This method will update an existing late fee with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateLateFee","name":"Updates a late fee with the specified ID.","isWebhook":false,"pointer":"/paths/~1lateFees~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a late fee with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing late fee with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the late fee to update.","required":true}],"pointer":"/paths/~1lateFees~1{tenantId}~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/LateFee"}},"schemaId":"components/schemas/LateFee","pointer":"/paths/~1lateFees~1{tenantId}~1{id}/put/requestBody","description":"The updated late fee that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/lateFees/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/LateFee"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/lateFees/{tenantId}/{id}","href":"late-fees/updatelatefee","openApiOperationId":"updateLateFee","summary":"Updates a late fee with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/LateFee","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LateFee"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The late fee was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LateFee"}},"schemaId":"components/schemas/LateFee","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The late fee supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The late fee could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The late fee could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve late fee based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1lateFees~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/LateFee","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LateFee"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/late-fees/updatelatefee"}],"panels":[]}]},"httpPath":"/lateFees/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Late Fees"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Late Fees","showPageActions":true},{"nodeType":"markdoc","content":"Late Fees"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/lateFees/{tenantId}","summary":"Gets all of the late fees in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/late-fees/listlatefees","deprecated":false},{"title":"/lateFees/{tenantId}","summary":"Creates a new late fee record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/late-fees/createlatefee","deprecated":false},{"title":"/lateFees/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/late-fees/executebatchoperations","deprecated":false},{"title":"/lateFees/{tenantId}/{id}","summary":"Returns a late fee from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/late-fees/deletelatefee","deprecated":false},{"title":"/lateFees/{tenantId}/{id}","summary":"Returns a late fee from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/late-fees/getlatefee","deprecated":false},{"title":"/lateFees/{tenantId}/{id}","summary":"Partially updates a late fee with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/late-fees/patchlatefee","deprecated":false},{"title":"/lateFees/{tenantId}/{id}","summary":"Updates a late fee with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/late-fees/updatelatefee","deprecated":false}]}]}]}]}},{"type":"group","label":"Legacy Import Products","link":"/apis/collect/collect-v1/legacy-import-products","routeSlug":"/apis/collect/collect-v1/legacy-import-products","items":[{"label":"Gets all of the legacy import products in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/legacy-import-products/listlegacyimportproducts","routeSlug":"/apis/collect/collect-v1/legacy-import-products/listlegacyimportproducts","metadata":{"seo":{"title":"Gets all of the legacy import products in the system.","description":"This method will scan all legacy import products and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listLegacyImportProducts","name":"Gets all of the legacy import products in the system.","isWebhook":false,"pointer":"/paths/~1legacyImportProducts~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the legacy import products in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all legacy import products and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1legacyImportProducts~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1legacyImportProducts~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/legacyImportProducts/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/legacyImportProducts/{tenantId}","href":"legacy-import-products/listlegacyimportproducts","openApiOperationId":"listLegacyImportProducts","summary":"Gets all of the legacy import products in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The legacy import productswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_446"}},"schemaId":"schema_446","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1legacyImportProducts~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_446","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_446"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/legacy-import-products/listlegacyimportproducts"}],"panels":[]}]},"httpPath":"/legacyImportProducts/{tenantId}"},{"label":"Creates a new legacy import product record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/legacy-import-products/createlegacyimportproduct","routeSlug":"/apis/collect/collect-v1/legacy-import-products/createlegacyimportproduct","metadata":{"seo":{"title":"Creates a new legacy import product record that does not already exist.","description":"This method will auto-generate an ID and create a new legacy import product. If an ID is specified for the legacy import product, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createLegacyImportProduct","name":"Creates a new legacy import product record that does not already exist.","isWebhook":false,"pointer":"/paths/~1legacyImportProducts~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new legacy import product record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new legacy import product. If an ID is specified for the legacy import product, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1legacyImportProducts~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LegacyImportProduct"}},"schemaId":"components/schemas/LegacyImportProduct","pointer":"/paths/~1legacyImportProducts~1{tenantId}/post/requestBody","description":"The legacy import product that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/legacyImportProducts/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/LegacyImportProduct"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/legacyImportProducts/{tenantId}","href":"legacy-import-products/createlegacyimportproduct","openApiOperationId":"createLegacyImportProduct","summary":"Creates a new legacy import product record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/LegacyImportProduct","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LegacyImportProduct"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The legacy import product was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LegacyImportProduct"}},"schemaId":"components/schemas/LegacyImportProduct","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The legacy import product you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The legacy import product could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add legacy import product based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1legacyImportProducts~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/LegacyImportProduct","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LegacyImportProduct"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/legacy-import-products/createlegacyimportproduct"}],"panels":[]}]},"httpPath":"/legacyImportProducts/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/legacy-import-products/executebatchoperations","routeSlug":"/apis/collect/collect-v1/legacy-import-products/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1legacyImportProducts~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1legacyImportProducts~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1legacyImportProducts~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/legacyImportProducts/{tenantId}/batch","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/legacyImportProducts/{tenantId}/batch","href":"legacy-import-products/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The legacy import product could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve legacy import product based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1legacyImportProducts~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/legacy-import-products/executebatchoperations"}],"panels":[]}]},"httpPath":"/legacyImportProducts/{tenantId}/batch"},{"label":"Returns a legacy import product from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/legacy-import-products/deletelegacyimportproduct","routeSlug":"/apis/collect/collect-v1/legacy-import-products/deletelegacyimportproduct","metadata":{"seo":{"title":"Returns a legacy import product from the system by its ID.","description":"This method will delete a legacy import product with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteLegacyImportProduct","name":"Returns a legacy import product from the system by its ID.","isWebhook":false,"pointer":"/paths/~1legacyImportProducts~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a legacy import product from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a legacy import product with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the legacy import product to delete.","required":true}],"pointer":"/paths/~1legacyImportProducts~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/legacyImportProducts/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/legacyImportProducts/{tenantId}/{id}","href":"legacy-import-products/deletelegacyimportproduct","openApiOperationId":"deleteLegacyImportProduct","summary":"Returns a legacy import product from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The legacy import product was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}},"schemaId":"schema_409","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The legacy import product could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The legacy import product could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to delete legacy import product based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1legacyImportProducts~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_409","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/legacy-import-products/deletelegacyimportproduct"}],"panels":[]}]},"httpPath":"/legacyImportProducts/{tenantId}/{id}"},{"label":"Returns a legacy import product from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/legacy-import-products/getlegacyimportproduct","routeSlug":"/apis/collect/collect-v1/legacy-import-products/getlegacyimportproduct","metadata":{"seo":{"title":"Returns a legacy import product from the system by its ID.","description":"This method will look up a legacy import product by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getLegacyImportProduct","name":"Returns a legacy import product from the system by its ID.","isWebhook":false,"pointer":"/paths/~1legacyImportProducts~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a legacy import product from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a legacy import product by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the legacy import product to return.","required":true}],"pointer":"/paths/~1legacyImportProducts~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_409","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1legacyImportProducts~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/legacyImportProducts/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/legacyImportProducts/{tenantId}/{id}","href":"legacy-import-products/getlegacyimportproduct","openApiOperationId":"getLegacyImportProduct","summary":"Returns a legacy import product from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The legacy import product was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LegacyImportProduct"}},"schemaId":"components/schemas/LegacyImportProduct","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The legacy import product could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve legacy import product based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1legacyImportProducts~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/LegacyImportProduct","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LegacyImportProduct"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/legacy-import-products/getlegacyimportproduct"}],"panels":[]}]},"httpPath":"/legacyImportProducts/{tenantId}/{id}"},{"label":"Partially updates a legacy import product with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/legacy-import-products/patchlegacyimportproduct","routeSlug":"/apis/collect/collect-v1/legacy-import-products/patchlegacyimportproduct","metadata":{"seo":{"title":"Partially updates a legacy import product with the specified ID.","description":"This method will patch an existing legacy import product with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchLegacyImportProduct","name":"Partially updates a legacy import product with the specified ID.","isWebhook":false,"pointer":"/paths/~1legacyImportProducts~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a legacy import product with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing legacy import product with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the legacy import product to patch.","required":true}],"pointer":"/paths/~1legacyImportProducts~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"schemaId":"schema_412","pointer":"/paths/~1legacyImportProducts~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/legacyImportProducts/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_412"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/legacyImportProducts/{tenantId}/{id}","href":"legacy-import-products/patchlegacyimportproduct","openApiOperationId":"patchLegacyImportProduct","summary":"Partially updates a legacy import product with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"schema_412","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The legacy import product was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LegacyImportProduct"}},"schemaId":"components/schemas/LegacyImportProduct","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The legacy import product could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The legacy import product could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve legacy import product based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1legacyImportProducts~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/LegacyImportProduct","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LegacyImportProduct"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/legacy-import-products/patchlegacyimportproduct"}],"panels":[]}]},"httpPath":"/legacyImportProducts/{tenantId}/{id}"},{"label":"Updates a legacy import product with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/legacy-import-products/updatelegacyimportproduct","routeSlug":"/apis/collect/collect-v1/legacy-import-products/updatelegacyimportproduct","metadata":{"seo":{"title":"Updates a legacy import product with the specified ID.","description":"This method will update an existing legacy import product with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateLegacyImportProduct","name":"Updates a legacy import product with the specified ID.","isWebhook":false,"pointer":"/paths/~1legacyImportProducts~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a legacy import product with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing legacy import product with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the legacy import product to update.","required":true}],"pointer":"/paths/~1legacyImportProducts~1{tenantId}~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/LegacyImportProduct"}},"schemaId":"components/schemas/LegacyImportProduct","pointer":"/paths/~1legacyImportProducts~1{tenantId}~1{id}/put/requestBody","description":"The updated legacy import product that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/legacyImportProducts/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/LegacyImportProduct"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/legacyImportProducts/{tenantId}/{id}","href":"legacy-import-products/updatelegacyimportproduct","openApiOperationId":"updateLegacyImportProduct","summary":"Updates a legacy import product with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/LegacyImportProduct","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LegacyImportProduct"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The legacy import product was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LegacyImportProduct"}},"schemaId":"components/schemas/LegacyImportProduct","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The legacy import product supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The legacy import product could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The legacy import product could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve legacy import product based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1legacyImportProducts~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/LegacyImportProduct","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/LegacyImportProduct"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/legacy-import-products/updatelegacyimportproduct"}],"panels":[]}]},"httpPath":"/legacyImportProducts/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Legacy Import Products"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Legacy Import Products","showPageActions":true},{"nodeType":"markdoc","content":"Legacy Import Products"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/legacyImportProducts/{tenantId}","summary":"Gets all of the legacy import products in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/legacy-import-products/listlegacyimportproducts","deprecated":false},{"title":"/legacyImportProducts/{tenantId}","summary":"Creates a new legacy import product record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/legacy-import-products/createlegacyimportproduct","deprecated":false},{"title":"/legacyImportProducts/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/legacy-import-products/executebatchoperations","deprecated":false},{"title":"/legacyImportProducts/{tenantId}/{id}","summary":"Returns a legacy import product from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/legacy-import-products/deletelegacyimportproduct","deprecated":false},{"title":"/legacyImportProducts/{tenantId}/{id}","summary":"Returns a legacy import product from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/legacy-import-products/getlegacyimportproduct","deprecated":false},{"title":"/legacyImportProducts/{tenantId}/{id}","summary":"Partially updates a legacy import product with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/legacy-import-products/patchlegacyimportproduct","deprecated":false},{"title":"/legacyImportProducts/{tenantId}/{id}","summary":"Updates a legacy import product with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/legacy-import-products/updatelegacyimportproduct","deprecated":false}]}]}]}]}},{"type":"group","label":"Merchant Accounts","link":"/apis/collect/collect-v1/merchant-accounts","routeSlug":"/apis/collect/collect-v1/merchant-accounts","items":[{"label":"Gets all of the merchant accounts in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/merchant-accounts/listmerchantaccounts","routeSlug":"/apis/collect/collect-v1/merchant-accounts/listmerchantaccounts","metadata":{"seo":{"title":"Gets all of the merchant accounts in the system.","description":"This method will scan all merchant accounts and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listMerchantAccounts","name":"Gets all of the merchant accounts in the system.","isWebhook":false,"pointer":"/paths/~1merchantAccounts~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the merchant accounts in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all merchant accounts and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1merchantAccounts~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1merchantAccounts~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/merchantAccounts/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/merchantAccounts/{tenantId}","href":"merchant-accounts/listmerchantaccounts","openApiOperationId":"listMerchantAccounts","summary":"Gets all of the merchant accounts in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The merchant accountswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_447"}},"schemaId":"schema_447","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1merchantAccounts~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_447","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_447"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/merchant-accounts/listmerchantaccounts"}],"panels":[]}]},"httpPath":"/merchantAccounts/{tenantId}"},{"label":"Creates a new merchant account record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/merchant-accounts/createmerchantaccount","routeSlug":"/apis/collect/collect-v1/merchant-accounts/createmerchantaccount","metadata":{"seo":{"title":"Creates a new merchant account record that does not already exist.","description":"This method will auto-generate an ID and create a new merchant account. If an ID is specified for the merchant account, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createMerchantAccount","name":"Creates a new merchant account record that does not already exist.","isWebhook":false,"pointer":"/paths/~1merchantAccounts~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new merchant account record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new merchant account. If an ID is specified for the merchant account, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1merchantAccounts~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MerchantAccount"}},"schemaId":"components/schemas/MerchantAccount","pointer":"/paths/~1merchantAccounts~1{tenantId}/post/requestBody","description":"The merchant account that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/merchantAccounts/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/MerchantAccount"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/merchantAccounts/{tenantId}","href":"merchant-accounts/createmerchantaccount","openApiOperationId":"createMerchantAccount","summary":"Creates a new merchant account record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/MerchantAccount","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MerchantAccount"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The merchant account was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MerchantAccount"}},"schemaId":"components/schemas/MerchantAccount","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The merchant account you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The merchant account could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add merchant account based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1merchantAccounts~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/MerchantAccount","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MerchantAccount"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/merchant-accounts/createmerchantaccount"}],"panels":[]}]},"httpPath":"/merchantAccounts/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/merchant-accounts/executebatchoperations","routeSlug":"/apis/collect/collect-v1/merchant-accounts/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1merchantAccounts~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1merchantAccounts~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1merchantAccounts~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/merchantAccounts/{tenantId}/batch","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/merchantAccounts/{tenantId}/batch","href":"merchant-accounts/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The merchant account could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve merchant account based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1merchantAccounts~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/merchant-accounts/executebatchoperations"}],"panels":[]}]},"httpPath":"/merchantAccounts/{tenantId}/batch"},{"label":"Gets all of the merchant accounts in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/merchant-accounts/listmerchantaccountspublic","routeSlug":"/apis/collect/collect-v1/merchant-accounts/listmerchantaccountspublic","metadata":{"seo":{"title":"Gets all of the merchant accounts in the system.","description":"This method will scan all merchant accounts and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listMerchantAccountsPublic","name":"Gets all of the merchant accounts in the system.","isWebhook":false,"pointer":"/paths/~1merchantAccounts~1{tenantId}~1public/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the merchant accounts in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all merchant accounts and and return them to the caller."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1merchantAccounts~1{tenantId}~1public/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1merchantAccounts~1{tenantId}~1public/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/merchantAccounts/{tenantId}/public","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/merchantAccounts/{tenantId}/public","href":"merchant-accounts/listmerchantaccountspublic","openApiOperationId":"listMerchantAccountsPublic","summary":"Gets all of the merchant accounts in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The merchant accountswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_447"}},"schemaId":"schema_447","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1merchantAccounts~1{tenantId}~1public/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_447","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_447"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/merchant-accounts/listmerchantaccountspublic"}],"panels":[]}]},"httpPath":"/merchantAccounts/{tenantId}/public"},{"label":"Returns a merchant account from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/merchant-accounts/deletemerchantaccount","routeSlug":"/apis/collect/collect-v1/merchant-accounts/deletemerchantaccount","metadata":{"seo":{"title":"Returns a merchant account from the system by its ID.","description":"This method will delete a merchant account with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteMerchantAccount","name":"Returns a merchant account from the system by its ID.","isWebhook":false,"pointer":"/paths/~1merchantAccounts~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a merchant account from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a merchant account with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the merchant account to delete.","required":true}],"pointer":"/paths/~1merchantAccounts~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/merchantAccounts/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/merchantAccounts/{tenantId}/{id}","href":"merchant-accounts/deletemerchantaccount","openApiOperationId":"deleteMerchantAccount","summary":"Returns a merchant account from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The merchant account was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}},"schemaId":"schema_409","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The merchant account could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The merchant account could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to delete merchant account based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1merchantAccounts~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_409","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/merchant-accounts/deletemerchantaccount"}],"panels":[]}]},"httpPath":"/merchantAccounts/{tenantId}/{id}"},{"label":"Returns a merchant account from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/merchant-accounts/getmerchantaccount","routeSlug":"/apis/collect/collect-v1/merchant-accounts/getmerchantaccount","metadata":{"seo":{"title":"Returns a merchant account from the system by its ID.","description":"This method will look up a merchant account by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getMerchantAccount","name":"Returns a merchant account from the system by its ID.","isWebhook":false,"pointer":"/paths/~1merchantAccounts~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a merchant account from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a merchant account by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the merchant account to return.","required":true}],"pointer":"/paths/~1merchantAccounts~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_409","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1merchantAccounts~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/merchantAccounts/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/merchantAccounts/{tenantId}/{id}","href":"merchant-accounts/getmerchantaccount","openApiOperationId":"getMerchantAccount","summary":"Returns a merchant account from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The merchant account was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MerchantAccount"}},"schemaId":"components/schemas/MerchantAccount","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The merchant account could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve merchant account based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1merchantAccounts~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/MerchantAccount","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MerchantAccount"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/merchant-accounts/getmerchantaccount"}],"panels":[]}]},"httpPath":"/merchantAccounts/{tenantId}/{id}"},{"label":"Partially updates a merchant account with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/merchant-accounts/patchmerchantaccount","routeSlug":"/apis/collect/collect-v1/merchant-accounts/patchmerchantaccount","metadata":{"seo":{"title":"Partially updates a merchant account with the specified ID.","description":"This method will patch an existing merchant account with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchMerchantAccount","name":"Partially updates a merchant account with the specified ID.","isWebhook":false,"pointer":"/paths/~1merchantAccounts~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a merchant account with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing merchant account with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the merchant account to patch.","required":true}],"pointer":"/paths/~1merchantAccounts~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"schemaId":"schema_412","pointer":"/paths/~1merchantAccounts~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/merchantAccounts/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_412"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/merchantAccounts/{tenantId}/{id}","href":"merchant-accounts/patchmerchantaccount","openApiOperationId":"patchMerchantAccount","summary":"Partially updates a merchant account with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"schema_412","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The merchant account was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MerchantAccount"}},"schemaId":"components/schemas/MerchantAccount","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The merchant account could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The merchant account could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve merchant account based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1merchantAccounts~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/MerchantAccount","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MerchantAccount"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/merchant-accounts/patchmerchantaccount"}],"panels":[]}]},"httpPath":"/merchantAccounts/{tenantId}/{id}"},{"label":"Updates a merchant account with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/merchant-accounts/updatemerchantaccount","routeSlug":"/apis/collect/collect-v1/merchant-accounts/updatemerchantaccount","metadata":{"seo":{"title":"Updates a merchant account with the specified ID.","description":"This method will update an existing merchant account with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateMerchantAccount","name":"Updates a merchant account with the specified ID.","isWebhook":false,"pointer":"/paths/~1merchantAccounts~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a merchant account with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing merchant account with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the merchant account to update.","required":true}],"pointer":"/paths/~1merchantAccounts~1{tenantId}~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/MerchantAccount"}},"schemaId":"components/schemas/MerchantAccount","pointer":"/paths/~1merchantAccounts~1{tenantId}~1{id}/put/requestBody","description":"The updated merchant account that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/merchantAccounts/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/MerchantAccount"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/merchantAccounts/{tenantId}/{id}","href":"merchant-accounts/updatemerchantaccount","openApiOperationId":"updateMerchantAccount","summary":"Updates a merchant account with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/MerchantAccount","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MerchantAccount"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The merchant account was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MerchantAccount"}},"schemaId":"components/schemas/MerchantAccount","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The merchant account supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The merchant account could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The merchant account could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve merchant account based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1merchantAccounts~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/MerchantAccount","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MerchantAccount"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/merchant-accounts/updatemerchantaccount"}],"panels":[]}]},"httpPath":"/merchantAccounts/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Merchant Accounts"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Merchant Accounts","showPageActions":true},{"nodeType":"markdoc","content":"Merchant Accounts"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/merchantAccounts/{tenantId}","summary":"Gets all of the merchant accounts in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/merchant-accounts/listmerchantaccounts","deprecated":false},{"title":"/merchantAccounts/{tenantId}","summary":"Creates a new merchant account record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/merchant-accounts/createmerchantaccount","deprecated":false},{"title":"/merchantAccounts/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/merchant-accounts/executebatchoperations","deprecated":false},{"title":"/merchantAccounts/{tenantId}/public","summary":"Gets all of the merchant accounts in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/merchant-accounts/listmerchantaccountspublic","deprecated":false},{"title":"/merchantAccounts/{tenantId}/{id}","summary":"Returns a merchant account from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/merchant-accounts/deletemerchantaccount","deprecated":false},{"title":"/merchantAccounts/{tenantId}/{id}","summary":"Returns a merchant account from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/merchant-accounts/getmerchantaccount","deprecated":false},{"title":"/merchantAccounts/{tenantId}/{id}","summary":"Partially updates a merchant account with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/merchant-accounts/patchmerchantaccount","deprecated":false},{"title":"/merchantAccounts/{tenantId}/{id}","summary":"Updates a merchant account with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/merchant-accounts/updatemerchantaccount","deprecated":false}]}]}]}]}},{"type":"group","label":"Miscellaneous Products","link":"/apis/collect/collect-v1/miscellaneous-products","routeSlug":"/apis/collect/collect-v1/miscellaneous-products","items":[{"label":"Gets all of the miscellaneous products in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/miscellaneous-products/listmiscellaneousproducts","routeSlug":"/apis/collect/collect-v1/miscellaneous-products/listmiscellaneousproducts","metadata":{"seo":{"title":"Gets all of the miscellaneous products in the system.","description":"This method will scan all miscellaneous products and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listMiscellaneousProducts","name":"Gets all of the miscellaneous products in the system.","isWebhook":false,"pointer":"/paths/~1miscellaneousProducts~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the miscellaneous products in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all miscellaneous products and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1miscellaneousProducts~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1miscellaneousProducts~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/miscellaneousProducts/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/miscellaneousProducts/{tenantId}","href":"miscellaneous-products/listmiscellaneousproducts","openApiOperationId":"listMiscellaneousProducts","summary":"Gets all of the miscellaneous products in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The miscellaneous productswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_448"}},"schemaId":"schema_448","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1miscellaneousProducts~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_448","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_448"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/miscellaneous-products/listmiscellaneousproducts"}],"panels":[]}]},"httpPath":"/miscellaneousProducts/{tenantId}"},{"label":"Creates a new miscellaneous product record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/miscellaneous-products/createmiscellaneousproduct","routeSlug":"/apis/collect/collect-v1/miscellaneous-products/createmiscellaneousproduct","metadata":{"seo":{"title":"Creates a new miscellaneous product record that does not already exist.","description":"This method will auto-generate an ID and create a new miscellaneous product. If an ID is specified for the miscellaneous product, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createMiscellaneousProduct","name":"Creates a new miscellaneous product record that does not already exist.","isWebhook":false,"pointer":"/paths/~1miscellaneousProducts~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new miscellaneous product record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new miscellaneous product. If an ID is specified for the miscellaneous product, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1miscellaneousProducts~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MiscellaneousProduct"}},"schemaId":"components/schemas/MiscellaneousProduct","pointer":"/paths/~1miscellaneousProducts~1{tenantId}/post/requestBody","description":"The miscellaneous product that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/miscellaneousProducts/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/MiscellaneousProduct"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/miscellaneousProducts/{tenantId}","href":"miscellaneous-products/createmiscellaneousproduct","openApiOperationId":"createMiscellaneousProduct","summary":"Creates a new miscellaneous product record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/MiscellaneousProduct","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MiscellaneousProduct"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The miscellaneous product was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MiscellaneousProduct"}},"schemaId":"components/schemas/MiscellaneousProduct","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The miscellaneous product you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The miscellaneous product could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add miscellaneous product based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1miscellaneousProducts~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/MiscellaneousProduct","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MiscellaneousProduct"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/miscellaneous-products/createmiscellaneousproduct"}],"panels":[]}]},"httpPath":"/miscellaneousProducts/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/miscellaneous-products/executebatchoperations","routeSlug":"/apis/collect/collect-v1/miscellaneous-products/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1miscellaneousProducts~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1miscellaneousProducts~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1miscellaneousProducts~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/miscellaneousProducts/{tenantId}/batch","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/miscellaneousProducts/{tenantId}/batch","href":"miscellaneous-products/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The miscellaneous product could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve miscellaneous product based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1miscellaneousProducts~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/miscellaneous-products/executebatchoperations"}],"panels":[]}]},"httpPath":"/miscellaneousProducts/{tenantId}/batch"},{"label":"Returns a miscellaneous product from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/miscellaneous-products/deletemiscellaneousproduct","routeSlug":"/apis/collect/collect-v1/miscellaneous-products/deletemiscellaneousproduct","metadata":{"seo":{"title":"Returns a miscellaneous product from the system by its ID.","description":"This method will delete a miscellaneous product with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteMiscellaneousProduct","name":"Returns a miscellaneous product from the system by its ID.","isWebhook":false,"pointer":"/paths/~1miscellaneousProducts~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a miscellaneous product from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a miscellaneous product with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the miscellaneous product to delete.","required":true}],"pointer":"/paths/~1miscellaneousProducts~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/miscellaneousProducts/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/miscellaneousProducts/{tenantId}/{id}","href":"miscellaneous-products/deletemiscellaneousproduct","openApiOperationId":"deleteMiscellaneousProduct","summary":"Returns a miscellaneous product from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The miscellaneous product was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}},"schemaId":"schema_409","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The miscellaneous product could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The miscellaneous product could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to delete miscellaneous product based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1miscellaneousProducts~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_409","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/miscellaneous-products/deletemiscellaneousproduct"}],"panels":[]}]},"httpPath":"/miscellaneousProducts/{tenantId}/{id}"},{"label":"Returns a miscellaneous product from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/miscellaneous-products/getmiscellaneousproduct","routeSlug":"/apis/collect/collect-v1/miscellaneous-products/getmiscellaneousproduct","metadata":{"seo":{"title":"Returns a miscellaneous product from the system by its ID.","description":"This method will look up a miscellaneous product by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getMiscellaneousProduct","name":"Returns a miscellaneous product from the system by its ID.","isWebhook":false,"pointer":"/paths/~1miscellaneousProducts~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a miscellaneous product from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a miscellaneous product by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the miscellaneous product to return.","required":true}],"pointer":"/paths/~1miscellaneousProducts~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_409","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1miscellaneousProducts~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/miscellaneousProducts/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/miscellaneousProducts/{tenantId}/{id}","href":"miscellaneous-products/getmiscellaneousproduct","openApiOperationId":"getMiscellaneousProduct","summary":"Returns a miscellaneous product from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The miscellaneous product was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MiscellaneousProduct"}},"schemaId":"components/schemas/MiscellaneousProduct","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The miscellaneous product could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve miscellaneous product based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1miscellaneousProducts~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/MiscellaneousProduct","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MiscellaneousProduct"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/miscellaneous-products/getmiscellaneousproduct"}],"panels":[]}]},"httpPath":"/miscellaneousProducts/{tenantId}/{id}"},{"label":"Partially updates a miscellaneous product with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/miscellaneous-products/patchmiscellaneousproduct","routeSlug":"/apis/collect/collect-v1/miscellaneous-products/patchmiscellaneousproduct","metadata":{"seo":{"title":"Partially updates a miscellaneous product with the specified ID.","description":"This method will patch an existing miscellaneous product with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchMiscellaneousProduct","name":"Partially updates a miscellaneous product with the specified ID.","isWebhook":false,"pointer":"/paths/~1miscellaneousProducts~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a miscellaneous product with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing miscellaneous product with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the miscellaneous product to patch.","required":true}],"pointer":"/paths/~1miscellaneousProducts~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"schemaId":"schema_412","pointer":"/paths/~1miscellaneousProducts~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/miscellaneousProducts/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_412"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/miscellaneousProducts/{tenantId}/{id}","href":"miscellaneous-products/patchmiscellaneousproduct","openApiOperationId":"patchMiscellaneousProduct","summary":"Partially updates a miscellaneous product with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"schema_412","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The miscellaneous product was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MiscellaneousProduct"}},"schemaId":"components/schemas/MiscellaneousProduct","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The miscellaneous product could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The miscellaneous product could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve miscellaneous product based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1miscellaneousProducts~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/MiscellaneousProduct","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MiscellaneousProduct"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/miscellaneous-products/patchmiscellaneousproduct"}],"panels":[]}]},"httpPath":"/miscellaneousProducts/{tenantId}/{id}"},{"label":"Updates a miscellaneous product with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/miscellaneous-products/updatemiscellaneousproduct","routeSlug":"/apis/collect/collect-v1/miscellaneous-products/updatemiscellaneousproduct","metadata":{"seo":{"title":"Updates a miscellaneous product with the specified ID.","description":"This method will update an existing miscellaneous product with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateMiscellaneousProduct","name":"Updates a miscellaneous product with the specified ID.","isWebhook":false,"pointer":"/paths/~1miscellaneousProducts~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a miscellaneous product with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing miscellaneous product with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the miscellaneous product to update.","required":true}],"pointer":"/paths/~1miscellaneousProducts~1{tenantId}~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/MiscellaneousProduct"}},"schemaId":"components/schemas/MiscellaneousProduct","pointer":"/paths/~1miscellaneousProducts~1{tenantId}~1{id}/put/requestBody","description":"The updated miscellaneous product that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/miscellaneousProducts/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/MiscellaneousProduct"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/miscellaneousProducts/{tenantId}/{id}","href":"miscellaneous-products/updatemiscellaneousproduct","openApiOperationId":"updateMiscellaneousProduct","summary":"Updates a miscellaneous product with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/MiscellaneousProduct","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/MiscellaneousProduct"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The miscellaneous product was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MiscellaneousProduct"}},"schemaId":"components/schemas/MiscellaneousProduct","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The miscellaneous product supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The miscellaneous product could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The miscellaneous product could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve miscellaneous product based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1miscellaneousProducts~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/MiscellaneousProduct","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MiscellaneousProduct"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/miscellaneous-products/updatemiscellaneousproduct"}],"panels":[]}]},"httpPath":"/miscellaneousProducts/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Miscellaneous Products"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Miscellaneous Products","showPageActions":true},{"nodeType":"markdoc","content":"Miscellaneous Products"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/miscellaneousProducts/{tenantId}","summary":"Gets all of the miscellaneous products in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/miscellaneous-products/listmiscellaneousproducts","deprecated":false},{"title":"/miscellaneousProducts/{tenantId}","summary":"Creates a new miscellaneous product record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/miscellaneous-products/createmiscellaneousproduct","deprecated":false},{"title":"/miscellaneousProducts/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/miscellaneous-products/executebatchoperations","deprecated":false},{"title":"/miscellaneousProducts/{tenantId}/{id}","summary":"Returns a miscellaneous product from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/miscellaneous-products/deletemiscellaneousproduct","deprecated":false},{"title":"/miscellaneousProducts/{tenantId}/{id}","summary":"Returns a miscellaneous product from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/miscellaneous-products/getmiscellaneousproduct","deprecated":false},{"title":"/miscellaneousProducts/{tenantId}/{id}","summary":"Partially updates a miscellaneous product with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/miscellaneous-products/patchmiscellaneousproduct","deprecated":false},{"title":"/miscellaneousProducts/{tenantId}/{id}","summary":"Updates a miscellaneous product with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/miscellaneous-products/updatemiscellaneousproduct","deprecated":false}]}]}]}]}},{"type":"group","label":"Payment Receipt Templates","link":"/apis/collect/collect-v1/payment-receipt-templates","routeSlug":"/apis/collect/collect-v1/payment-receipt-templates","items":[{"label":"Gets all of the payment receipt templates in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/payment-receipt-templates/listpaymentreceipttemplates","routeSlug":"/apis/collect/collect-v1/payment-receipt-templates/listpaymentreceipttemplates","metadata":{"seo":{"title":"Gets all of the payment receipt templates in the system.","description":"This method will scan all payment receipt templates and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listPaymentReceiptTemplates","name":"Gets all of the payment receipt templates in the system.","isWebhook":false,"pointer":"/paths/~1paymentReceiptTemplates~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the payment receipt templates in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all payment receipt templates and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1paymentReceiptTemplates~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1paymentReceiptTemplates~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/paymentReceiptTemplates/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/paymentReceiptTemplates/{tenantId}","href":"payment-receipt-templates/listpaymentreceipttemplates","openApiOperationId":"listPaymentReceiptTemplates","summary":"Gets all of the payment receipt templates in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The payment receipt templateswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_449"}},"schemaId":"schema_449","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1paymentReceiptTemplates~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_449","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_449"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-receipt-templates/listpaymentreceipttemplates"}],"panels":[]}]},"httpPath":"/paymentReceiptTemplates/{tenantId}"},{"label":"Creates a new payment receipt template record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/payment-receipt-templates/createpaymentreceipttemplate","routeSlug":"/apis/collect/collect-v1/payment-receipt-templates/createpaymentreceipttemplate","metadata":{"seo":{"title":"Creates a new payment receipt template record that does not already exist.","description":"This method will auto-generate an ID and create a new payment receipt template. If an ID is specified for the payment receipt template, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createPaymentReceiptTemplate","name":"Creates a new payment receipt template record that does not already exist.","isWebhook":false,"pointer":"/paths/~1paymentReceiptTemplates~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new payment receipt template record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new payment receipt template. If an ID is specified for the payment receipt template, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1paymentReceiptTemplates~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/InvoiceTemplate"}},"schemaId":"components/schemas/InvoiceTemplate","pointer":"/paths/~1paymentReceiptTemplates~1{tenantId}/post/requestBody","description":"The payment receipt template that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/paymentReceiptTemplates/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/InvoiceTemplate"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/paymentReceiptTemplates/{tenantId}","href":"payment-receipt-templates/createpaymentreceipttemplate","openApiOperationId":"createPaymentReceiptTemplate","summary":"Creates a new payment receipt template record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/InvoiceTemplate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/InvoiceTemplate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The payment receipt template was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvoiceTemplate"}},"schemaId":"components/schemas/InvoiceTemplate","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The payment receipt template you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The payment receipt template could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add payment receipt template based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1paymentReceiptTemplates~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/InvoiceTemplate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvoiceTemplate"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-receipt-templates/createpaymentreceipttemplate"}],"panels":[]}]},"httpPath":"/paymentReceiptTemplates/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/payment-receipt-templates/executebatchoperations","routeSlug":"/apis/collect/collect-v1/payment-receipt-templates/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1paymentReceiptTemplates~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1paymentReceiptTemplates~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1paymentReceiptTemplates~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/paymentReceiptTemplates/{tenantId}/batch","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/paymentReceiptTemplates/{tenantId}/batch","href":"payment-receipt-templates/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The payment receipt template could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve payment receipt template based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1paymentReceiptTemplates~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-receipt-templates/executebatchoperations"}],"panels":[]}]},"httpPath":"/paymentReceiptTemplates/{tenantId}/batch"},{"label":"Returns a payment receipt template from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/payment-receipt-templates/deletepaymentreceipttemplate","routeSlug":"/apis/collect/collect-v1/payment-receipt-templates/deletepaymentreceipttemplate","metadata":{"seo":{"title":"Returns a payment receipt template from the system by its ID.","description":"This method will delete a payment receipt template with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deletePaymentReceiptTemplate","name":"Returns a payment receipt template from the system by its ID.","isWebhook":false,"pointer":"/paths/~1paymentReceiptTemplates~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a payment receipt template from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a payment receipt template with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the payment receipt template to delete.","required":true}],"pointer":"/paths/~1paymentReceiptTemplates~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/paymentReceiptTemplates/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/paymentReceiptTemplates/{tenantId}/{id}","href":"payment-receipt-templates/deletepaymentreceipttemplate","openApiOperationId":"deletePaymentReceiptTemplate","summary":"Returns a payment receipt template from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The payment receipt template was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}},"schemaId":"schema_409","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The payment receipt template could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The payment receipt template could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to delete payment receipt template based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1paymentReceiptTemplates~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_409","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-receipt-templates/deletepaymentreceipttemplate"}],"panels":[]}]},"httpPath":"/paymentReceiptTemplates/{tenantId}/{id}"},{"label":"Returns a payment receipt template from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/payment-receipt-templates/getpaymentreceipttemplate","routeSlug":"/apis/collect/collect-v1/payment-receipt-templates/getpaymentreceipttemplate","metadata":{"seo":{"title":"Returns a payment receipt template from the system by its ID.","description":"This method will look up a payment receipt template by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPaymentReceiptTemplate","name":"Returns a payment receipt template from the system by its ID.","isWebhook":false,"pointer":"/paths/~1paymentReceiptTemplates~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a payment receipt template from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a payment receipt template by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the payment receipt template to return.","required":true}],"pointer":"/paths/~1paymentReceiptTemplates~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_409","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1paymentReceiptTemplates~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/paymentReceiptTemplates/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/paymentReceiptTemplates/{tenantId}/{id}","href":"payment-receipt-templates/getpaymentreceipttemplate","openApiOperationId":"getPaymentReceiptTemplate","summary":"Returns a payment receipt template from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The payment receipt template was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvoiceTemplate"}},"schemaId":"components/schemas/InvoiceTemplate","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The payment receipt template could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve payment receipt template based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1paymentReceiptTemplates~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/InvoiceTemplate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvoiceTemplate"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-receipt-templates/getpaymentreceipttemplate"}],"panels":[]}]},"httpPath":"/paymentReceiptTemplates/{tenantId}/{id}"},{"label":"Partially updates a payment receipt template with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/payment-receipt-templates/patchpaymentreceipttemplate","routeSlug":"/apis/collect/collect-v1/payment-receipt-templates/patchpaymentreceipttemplate","metadata":{"seo":{"title":"Partially updates a payment receipt template with the specified ID.","description":"This method will patch an existing payment receipt template with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchPaymentReceiptTemplate","name":"Partially updates a payment receipt template with the specified ID.","isWebhook":false,"pointer":"/paths/~1paymentReceiptTemplates~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a payment receipt template with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing payment receipt template with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the payment receipt template to patch.","required":true}],"pointer":"/paths/~1paymentReceiptTemplates~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"schemaId":"schema_412","pointer":"/paths/~1paymentReceiptTemplates~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/paymentReceiptTemplates/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_412"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/paymentReceiptTemplates/{tenantId}/{id}","href":"payment-receipt-templates/patchpaymentreceipttemplate","openApiOperationId":"patchPaymentReceiptTemplate","summary":"Partially updates a payment receipt template with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"schema_412","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The payment receipt template was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvoiceTemplate"}},"schemaId":"components/schemas/InvoiceTemplate","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The payment receipt template could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The payment receipt template could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve payment receipt template based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1paymentReceiptTemplates~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/InvoiceTemplate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvoiceTemplate"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-receipt-templates/patchpaymentreceipttemplate"}],"panels":[]}]},"httpPath":"/paymentReceiptTemplates/{tenantId}/{id}"},{"label":"Updates a payment receipt template with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/payment-receipt-templates/updatepaymentreceipttemplate","routeSlug":"/apis/collect/collect-v1/payment-receipt-templates/updatepaymentreceipttemplate","metadata":{"seo":{"title":"Updates a payment receipt template with the specified ID.","description":"This method will update an existing payment receipt template with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updatePaymentReceiptTemplate","name":"Updates a payment receipt template with the specified ID.","isWebhook":false,"pointer":"/paths/~1paymentReceiptTemplates~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a payment receipt template with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing payment receipt template with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the payment receipt template to update.","required":true}],"pointer":"/paths/~1paymentReceiptTemplates~1{tenantId}~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/InvoiceTemplate"}},"schemaId":"components/schemas/InvoiceTemplate","pointer":"/paths/~1paymentReceiptTemplates~1{tenantId}~1{id}/put/requestBody","description":"The updated payment receipt template that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/paymentReceiptTemplates/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/InvoiceTemplate"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/paymentReceiptTemplates/{tenantId}/{id}","href":"payment-receipt-templates/updatepaymentreceipttemplate","openApiOperationId":"updatePaymentReceiptTemplate","summary":"Updates a payment receipt template with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/InvoiceTemplate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/InvoiceTemplate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The payment receipt template was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvoiceTemplate"}},"schemaId":"components/schemas/InvoiceTemplate","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The payment receipt template supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The payment receipt template could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The payment receipt template could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve payment receipt template based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1paymentReceiptTemplates~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/InvoiceTemplate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InvoiceTemplate"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payment-receipt-templates/updatepaymentreceipttemplate"}],"panels":[]}]},"httpPath":"/paymentReceiptTemplates/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Payment Receipt Templates"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payment Receipt Templates","showPageActions":true},{"nodeType":"markdoc","content":"Payment Receipt Templates"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/paymentReceiptTemplates/{tenantId}","summary":"Gets all of the payment receipt templates in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payment-receipt-templates/listpaymentreceipttemplates","deprecated":false},{"title":"/paymentReceiptTemplates/{tenantId}","summary":"Creates a new payment receipt template record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-receipt-templates/createpaymentreceipttemplate","deprecated":false},{"title":"/paymentReceiptTemplates/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payment-receipt-templates/executebatchoperations","deprecated":false},{"title":"/paymentReceiptTemplates/{tenantId}/{id}","summary":"Returns a payment receipt template from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/payment-receipt-templates/deletepaymentreceipttemplate","deprecated":false},{"title":"/paymentReceiptTemplates/{tenantId}/{id}","summary":"Returns a payment receipt template from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payment-receipt-templates/getpaymentreceipttemplate","deprecated":false},{"title":"/paymentReceiptTemplates/{tenantId}/{id}","summary":"Partially updates a payment receipt template with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/payment-receipt-templates/patchpaymentreceipttemplate","deprecated":false},{"title":"/paymentReceiptTemplates/{tenantId}/{id}","summary":"Updates a payment receipt template with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/payment-receipt-templates/updatepaymentreceipttemplate","deprecated":false}]}]}]}]}},{"type":"group","label":"Payments","link":"/apis/collect/collect-v1/payments","routeSlug":"/apis/collect/collect-v1/payments","items":[{"label":"Returns the default payment template","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/payments/getdefaultpaymentreceipttemplate","routeSlug":"/apis/collect/collect-v1/payments/getdefaultpaymentreceipttemplate","metadata":{"seo":{"title":"Returns the default payment template","description":"Returns the default payment template"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDefaultPaymentReceiptTemplate","name":"Returns the default payment template","isWebhook":false,"pointer":"/paths/~1payments~1defaultTemplate~1paymentReceipt/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns the default payment template","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the default payment template"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/payments/defaultTemplate/paymentReceipt","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/payments/defaultTemplate/paymentReceipt","href":"payments/getdefaultpaymentreceipttemplate","openApiOperationId":"getDefaultPaymentReceiptTemplate","summary":"Returns the default payment template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The payment template","mediaType":"text/html","mediaTypes":["text/html"],"mediaTypeContent":{"text/html":{"schemaId":"schema_409"}},"schemaId":"schema_409","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The payment could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve payment based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1payments~1defaultTemplate~1paymentReceipt/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_409","mediaTypes":["text/html"],"mediaTypeContent":{"text/html":{"schemaId":"schema_409"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payments/getdefaultpaymentreceipttemplate"}],"panels":[]}]},"httpPath":"/payments/defaultTemplate/paymentReceipt"},{"label":"Returns the default payment template","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/payments/getdefaultpaymenttemplateandemail","routeSlug":"/apis/collect/collect-v1/payments/getdefaultpaymenttemplateandemail","metadata":{"seo":{"title":"Returns the default payment template","description":"Returns the default payment template"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDefaultPaymentTemplateAndEmail","name":"Returns the default payment template","isWebhook":false,"pointer":"/paths/~1payments~1defaultTemplateAndEmail~1payment/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns the default payment template","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the default payment template"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/payments/defaultTemplateAndEmail/payment","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/payments/defaultTemplateAndEmail/payment","href":"payments/getdefaultpaymenttemplateandemail","openApiOperationId":"getDefaultPaymentTemplateAndEmail","summary":"Returns the default payment template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The payment template","mediaType":"text/html","mediaTypes":["text/html"],"mediaTypeContent":{"text/html":{"schemaId":"schema_442"}},"schemaId":"schema_442","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Request limit exceeded... please try your request again in a few seconds","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"An internal server error occured.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1payments~1defaultTemplateAndEmail~1payment/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_442","mediaTypes":["text/html"],"mediaTypeContent":{"text/html":{"schemaId":"schema_442"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payments/getdefaultpaymenttemplateandemail"}],"panels":[]}]},"httpPath":"/payments/defaultTemplateAndEmail/payment"},{"label":"Initiates workflow to warm up inventory transactions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/payments/warmupstepfunctions","routeSlug":"/apis/collect/collect-v1/payments/warmupstepfunctions","metadata":{"seo":{"title":"Initiates workflow to warm up inventory transactions","description":"Initiates workflow to warm up inventory transactions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"warmUpStepFunctions","name":"Initiates workflow to warm up inventory transactions","isWebhook":false,"pointer":"/paths/~1payments~1warmUpStepFunctions/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Initiates workflow to warm up inventory transactions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/payments/warmUpStepFunctions","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/payments/warmUpStepFunctions","href":"payments/warmupstepfunctions","openApiOperationId":"warmUpStepFunctions","summary":"Initiates workflow to warm up inventory transactions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Request limit exceeded... please try your request again in a few seconds","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"An internal server error occured.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1payments~1warmUpStepFunctions/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payments/warmupstepfunctions"}],"panels":[]}]},"httpPath":"/payments/warmUpStepFunctions"},{"label":"Processes a payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/payments/processpayment","routeSlug":"/apis/collect/collect-v1/payments/processpayment","metadata":{"seo":{"title":"Processes a payment","description":"This method will auto-generate an ID and create a new payment. If an ID is specified for the payment, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"processPayment","name":"Processes a payment","isWebhook":false,"pointer":"/paths/~1payments~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Processes a payment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new payment. If an ID is specified for the payment, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1payments~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Payment"}},"schemaId":"components/schemas/Payment","pointer":"/paths/~1payments~1{tenantId}/post/requestBody","description":"The payment that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/payments/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Payment"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/payments/{tenantId}","href":"payments/processpayment","openApiOperationId":"processPayment","summary":"Processes a payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Payment","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Payment"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The payment process was started","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StepFunctionExecutionToken"}},"schemaId":"components/schemas/StepFunctionExecutionToken","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The payment you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The payment could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add payment based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1payments~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/StepFunctionExecutionToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StepFunctionExecutionToken"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payments/processpayment"}],"panels":[]}]},"httpPath":"/payments/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/payments/executebatchoperations","routeSlug":"/apis/collect/collect-v1/payments/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1payments~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1payments~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1payments~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/payments/{tenantId}/batch","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/payments/{tenantId}/batch","href":"payments/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The payment could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve payment based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1payments~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payments/executebatchoperations"}],"panels":[]}]},"httpPath":"/payments/{tenantId}/batch"},{"label":"Returns a list of records with the specified batch_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/payments/listpaymentsbybatchid","routeSlug":"/apis/collect/collect-v1/payments/listpaymentsbybatchid","metadata":{"seo":{"title":"Returns a list of records with the specified batch_id","description":"Returns a list of records with the specified batch_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listPaymentsByBatchId","name":"Returns a list of records with the specified batch_id","isWebhook":false,"pointer":"/paths/~1payments~1{tenantId}~1batch~1{batch_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified batch_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":"Returns a list of records with the specified batch_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The tenant","required":true},{"name":"batch_id","in":"path","schemaId":"schema_409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The batch_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1payments~1{tenantId}~1batch~1{batch_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1payments~1{tenantId}~1batch~1{batch_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/payments/{tenantId}/batch/{batch_id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"batch_id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/payments/{tenantId}/batch/{batch_id}","href":"payments/listpaymentsbybatchid","openApiOperationId":"listPaymentsByBatchId","summary":"Returns a list of records with the specified batch_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListPaymentsResponse"}},"schemaId":"components/schemas/ListPaymentsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1payments~1{tenantId}~1batch~1{batch_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListPaymentsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListPaymentsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payments/listpaymentsbybatchid"}],"panels":[]}]},"httpPath":"/payments/{tenantId}/batch/{batch_id}"},{"label":"Returns a list of records with the specified contact_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/payments/listpaymentsbycontactid","routeSlug":"/apis/collect/collect-v1/payments/listpaymentsbycontactid","metadata":{"seo":{"title":"Returns a list of records with the specified contact_id","description":"Returns a list of records with the specified contact_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listPaymentsByContactId","name":"Returns a list of records with the specified contact_id","isWebhook":false,"pointer":"/paths/~1payments~1{tenantId}~1contact~1{contact_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified contact_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":"Returns a list of records with the specified contact_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The tenant","required":true},{"name":"contact_id","in":"path","schemaId":"schema_409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contact_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1payments~1{tenantId}~1contact~1{contact_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1payments~1{tenantId}~1contact~1{contact_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/payments/{tenantId}/contact/{contact_id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"contact_id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/payments/{tenantId}/contact/{contact_id}","href":"payments/listpaymentsbycontactid","openApiOperationId":"listPaymentsByContactId","summary":"Returns a list of records with the specified contact_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListPaymentsResponse"}},"schemaId":"components/schemas/ListPaymentsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1payments~1{tenantId}~1contact~1{contact_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListPaymentsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListPaymentsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payments/listpaymentsbycontactid"}],"panels":[]}]},"httpPath":"/payments/{tenantId}/contact/{contact_id}"},{"label":"Emails an HTML version of the payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/payments/emailpayment","routeSlug":"/apis/collect/collect-v1/payments/emailpayment","metadata":{"seo":{"title":"Emails an HTML version of the payment","description":"Send an email of the payment"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"emailPayment","name":"Emails an HTML version of the payment","isWebhook":false,"pointer":"/paths/~1payments~1{tenantId}~1email~1{id}/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Emails an HTML version of the payment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Send an email of the payment"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the payment to return","required":true}],"pointer":"/paths/~1payments~1{tenantId}~1email~1{id}/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"additionalRecipients","in":"query","schemaId":"schema_409","description":"Others who should receive the email"}],"pointer":"/paths/~1payments~1{tenantId}~1email~1{id}/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/payments/{tenantId}/email/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"additionalRecipients","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/payments/{tenantId}/email/{id}","href":"payments/emailpayment","openApiOperationId":"emailPayment","summary":"Emails an HTML version of the payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The payment was emailed successfully","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The payment could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve payment based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1payments~1{tenantId}~1email~1{id}/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payments/emailpayment"}],"panels":[]}]},"httpPath":"/payments/{tenantId}/email/{id}"},{"label":"Returns a list of records with the specified order_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/payments/listpaymentsbyorderid","routeSlug":"/apis/collect/collect-v1/payments/listpaymentsbyorderid","metadata":{"seo":{"title":"Returns a list of records with the specified order_id","description":"Returns a list of records with the specified order_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listPaymentsByOrderId","name":"Returns a list of records with the specified order_id","isWebhook":false,"pointer":"/paths/~1payments~1{tenantId}~1order~1{order_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified order_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":"Returns a list of records with the specified order_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The tenant","required":true},{"name":"order_id","in":"path","schemaId":"schema_409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The order_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1payments~1{tenantId}~1order~1{order_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1payments~1{tenantId}~1order~1{order_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/payments/{tenantId}/order/{order_id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"order_id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/payments/{tenantId}/order/{order_id}","href":"payments/listpaymentsbyorderid","openApiOperationId":"listPaymentsByOrderId","summary":"Returns a list of records with the specified order_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListPaymentsResponse"}},"schemaId":"components/schemas/ListPaymentsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1payments~1{tenantId}~1order~1{order_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListPaymentsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListPaymentsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payments/listpaymentsbyorderid"}],"panels":[]}]},"httpPath":"/payments/{tenantId}/order/{order_id}"},{"label":"Returns a list of records with the specified organization_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/payments/listpaymentsbyorganizationid","routeSlug":"/apis/collect/collect-v1/payments/listpaymentsbyorganizationid","metadata":{"seo":{"title":"Returns a list of records with the specified organization_id","description":"Returns a list of records with the specified organization_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listPaymentsByOrganizationId","name":"Returns a list of records with the specified organization_id","isWebhook":false,"pointer":"/paths/~1payments~1{tenantId}~1organization~1{organization_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified organization_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":"Returns a list of records with the specified organization_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The tenant","required":true},{"name":"organization_id","in":"path","schemaId":"schema_409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The organization_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1payments~1{tenantId}~1organization~1{organization_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1payments~1{tenantId}~1organization~1{organization_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/payments/{tenantId}/organization/{organization_id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"organization_id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/payments/{tenantId}/organization/{organization_id}","href":"payments/listpaymentsbyorganizationid","openApiOperationId":"listPaymentsByOrganizationId","summary":"Returns a list of records with the specified organization_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListPaymentsResponse"}},"schemaId":"components/schemas/ListPaymentsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1payments~1{tenantId}~1organization~1{organization_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListPaymentsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListPaymentsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payments/listpaymentsbyorganizationid"}],"panels":[]}]},"httpPath":"/payments/{tenantId}/organization/{organization_id}"},{"label":"Returns a list of records with the specified owner","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/payments/listpaymentsbyowner","routeSlug":"/apis/collect/collect-v1/payments/listpaymentsbyowner","metadata":{"seo":{"title":"Returns a list of records with the specified owner","description":"Returns a list of records with the specified owner"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listPaymentsByOwner","name":"Returns a list of records with the specified owner","isWebhook":false,"pointer":"/paths/~1payments~1{tenantId}~1owner~1{ownerType}~1{ownerId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified owner","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 records with the specified owner"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The tenant","required":true},{"name":"ownerType","in":"path","schemaId":"components/schemas/OwnerType","description":"The type of owner","required":true},{"name":"ownerId","in":"path","schemaId":"schema_409","description":"The ID of the owner","required":true}],"pointer":"/paths/~1payments~1{tenantId}~1owner~1{ownerType}~1{ownerId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"If paging, this allows you to return the next set of results"},{"name":"includeAllPayments","in":"query","schemaId":"schema_428","description":"If set, all payments are returned regardless of balance"}],"pointer":"/paths/~1payments~1{tenantId}~1owner~1{ownerType}~1{ownerId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/payments/{tenantId}/owner/{ownerType}/{ownerId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"ownerType","in":"path","required":true,"schemaId":"components/schemas/OwnerType"},{"name":"ownerId","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"},{"name":"includeAllPayments","in":"query","required":false,"schemaId":"schema_428"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/payments/{tenantId}/owner/{ownerType}/{ownerId}","href":"payments/listpaymentsbyowner","openApiOperationId":"listPaymentsByOwner","summary":"Returns a list of records with the specified owner"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListPaymentsResponse"}},"schemaId":"components/schemas/ListPaymentsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1payments~1{tenantId}~1owner~1{ownerType}~1{ownerId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListPaymentsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListPaymentsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payments/listpaymentsbyowner"}],"panels":[]}]},"httpPath":"/payments/{tenantId}/owner/{ownerType}/{ownerId}"},{"label":"Gets all of the payments in the system for a given contact.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/payments/listpaymentsforportal","routeSlug":"/apis/collect/collect-v1/payments/listpaymentsforportal","metadata":{"seo":{"title":"Gets all of the payments in the system for a given contact.","description":"This method will scan all payments and and return them to the caller for a given contact."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listPaymentsForPortal","name":"Gets all of the payments in the system for a given contact.","isWebhook":false,"pointer":"/paths/~1payments~1{tenantId}~1portal~1contact~1{portalContactId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the payments in the system for a given contact.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all payments and and return them to the caller for a given contact."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"portalContactId","in":"path","schemaId":"schema_409","description":"The contact to use","required":true}],"pointer":"/paths/~1payments~1{tenantId}~1portal~1contact~1{portalContactId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."}],"pointer":"/paths/~1payments~1{tenantId}~1portal~1contact~1{portalContactId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/payments/{tenantId}/portal/contact/{portalContactId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"portalContactId","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/payments/{tenantId}/portal/contact/{portalContactId}","href":"payments/listpaymentsforportal","openApiOperationId":"listPaymentsForPortal","summary":"Gets all of the payments in the system for a given contact."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The paymentswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListPaymentsResponse"}},"schemaId":"components/schemas/ListPaymentsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1payments~1{tenantId}~1portal~1contact~1{portalContactId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListPaymentsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListPaymentsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payments/listpaymentsforportal"}],"panels":[]}]},"httpPath":"/payments/{tenantId}/portal/contact/{portalContactId}"},{"label":"Returns a payment from the system by its ID for a given contact.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/payments/getpaymentforportal","routeSlug":"/apis/collect/collect-v1/payments/getpaymentforportal","metadata":{"seo":{"title":"Returns a payment from the system by its ID for a given contact.","description":"This method will look up a payment by the specified ID and return it back (for a portal contact)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPaymentForPortal","name":"Returns a payment from the system by its ID for a given contact.","isWebhook":false,"pointer":"/paths/~1payments~1{tenantId}~1portal~1contact~1{portalContactId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a payment from the system by its ID for a given contact.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a payment by the specified ID and return it back (for a portal contact)"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"portalContactId","in":"path","schemaId":"schema_409","description":"The contact to use","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the payment to return.","required":true}],"pointer":"/paths/~1payments~1{tenantId}~1portal~1contact~1{portalContactId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_409","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1payments~1{tenantId}~1portal~1contact~1{portalContactId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/payments/{tenantId}/portal/contact/{portalContactId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"portalContactId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/payments/{tenantId}/portal/contact/{portalContactId}/{id}","href":"payments/getpaymentforportal","openApiOperationId":"getPaymentForPortal","summary":"Returns a payment from the system by its ID for a given contact."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The payment was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Payment"}},"schemaId":"components/schemas/Payment","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The payment could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve payment based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1payments~1{tenantId}~1portal~1contact~1{portalContactId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Payment","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Payment"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payments/getpaymentforportal"}],"panels":[]}]},"httpPath":"/payments/{tenantId}/portal/contact/{portalContactId}/{id}"},{"label":"Gets all of the payments in the system for a given organization.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/payments/listpaymentsforportalbyorganization","routeSlug":"/apis/collect/collect-v1/payments/listpaymentsforportalbyorganization","metadata":{"seo":{"title":"Gets all of the payments in the system for a given organization.","description":"This method will scan all payments and and return them to the caller for a given organization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listPaymentsForPortalByOrganization","name":"Gets all of the payments in the system for a given organization.","isWebhook":false,"pointer":"/paths/~1payments~1{tenantId}~1portal~1organization~1{portalOrganizationId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the payments in the system for a given organization.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all payments and and return them to the caller for a given organization."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"portalOrganizationId","in":"path","schemaId":"schema_409","description":"The organization to use","required":true}],"pointer":"/paths/~1payments~1{tenantId}~1portal~1organization~1{portalOrganizationId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."}],"pointer":"/paths/~1payments~1{tenantId}~1portal~1organization~1{portalOrganizationId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/payments/{tenantId}/portal/organization/{portalOrganizationId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"portalOrganizationId","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/payments/{tenantId}/portal/organization/{portalOrganizationId}","href":"payments/listpaymentsforportalbyorganization","openApiOperationId":"listPaymentsForPortalByOrganization","summary":"Gets all of the payments in the system for a given organization."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The paymentswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListPaymentsResponse"}},"schemaId":"components/schemas/ListPaymentsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add organization role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1payments~1{tenantId}~1portal~1organization~1{portalOrganizationId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListPaymentsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListPaymentsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payments/listpaymentsforportalbyorganization"}],"panels":[]}]},"httpPath":"/payments/{tenantId}/portal/organization/{portalOrganizationId}"},{"label":"Returns a payment from the system by its ID for a given organization.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/payments/getpaymentforportal","routeSlug":"/apis/collect/collect-v1/payments/getpaymentforportal","metadata":{"seo":{"title":"Returns a payment from the system by its ID for a given organization.","description":"This method will look up a payment by the specified ID and return it back (for a portal organization)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPaymentForPortal","name":"Returns a payment from the system by its ID for a given organization.","isWebhook":false,"pointer":"/paths/~1payments~1{tenantId}~1portal~1organization~1{portalOrganizationId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a payment from the system by its ID for a given organization.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a payment by the specified ID and return it back (for a portal organization)"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"portalOrganizationId","in":"path","schemaId":"schema_409","description":"The organization to use","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the payment to return.","required":true}],"pointer":"/paths/~1payments~1{tenantId}~1portal~1organization~1{portalOrganizationId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_409","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1payments~1{tenantId}~1portal~1organization~1{portalOrganizationId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/payments/{tenantId}/portal/organization/{portalOrganizationId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"portalOrganizationId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/payments/{tenantId}/portal/organization/{portalOrganizationId}/{id}","href":"payments/getpaymentforportal","openApiOperationId":"getPaymentForPortal","summary":"Returns a payment from the system by its ID for a given organization."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The payment was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Payment"}},"schemaId":"components/schemas/Payment","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The payment could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve payment based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1payments~1{tenantId}~1portal~1organization~1{portalOrganizationId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Payment","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Payment"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payments/getpaymentforportal"}],"panels":[]}]},"httpPath":"/payments/{tenantId}/portal/organization/{portalOrganizationId}/{id}"},{"label":"Sends out a preview of the CRC notification email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/payments/previewemail","routeSlug":"/apis/collect/collect-v1/payments/previewemail","metadata":{"seo":{"title":"Sends out a preview of the CRC notification email","description":"Sends out a preview of the CRC notification email"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"previewEmail","name":"Sends out a preview of the CRC notification email","isWebhook":false,"pointer":"/paths/~1payments~1{tenantId}~1previewEmail/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sends out a preview of the CRC notification email","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Sends out a preview of the CRC notification email"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The tenant","required":true}],"pointer":"/paths/~1payments~1{tenantId}~1previewEmail/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PreviewEmailRequest"}},"schemaId":"components/schemas/PreviewEmailRequest","pointer":"/paths/~1payments~1{tenantId}~1previewEmail/post/requestBody","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The domain_name to use to for record lookup"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/payments/{tenantId}/previewEmail","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PreviewEmailRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/payments/{tenantId}/previewEmail","href":"payments/previewemail","openApiOperationId":"previewEmail","summary":"Sends out a preview of the CRC notification email"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/PreviewEmailRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PreviewEmailRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The record was retrieved successfully","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"Unable to locate any organizations with the specified domain","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1payments~1{tenantId}~1previewEmail/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payments/previewemail"}],"panels":[]}]},"httpPath":"/payments/{tenantId}/previewEmail"},{"label":"Sends out a preview of the notification template","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/payments/previewtemplate","routeSlug":"/apis/collect/collect-v1/payments/previewtemplate","metadata":{"seo":{"title":"Sends out a preview of the notification template","description":"Sends out a preview of the notification template"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"previewTemplate","name":"Sends out a preview of the notification template","isWebhook":false,"pointer":"/paths/~1payments~1{tenantId}~1previewTemplate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sends out a preview of the notification template","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Sends out a preview of the notification template"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The tenant","required":true}],"pointer":"/paths/~1payments~1{tenantId}~1previewTemplate/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PreviewTemplateRequest"}},"schemaId":"components/schemas/PreviewTemplateRequest","pointer":"/paths/~1payments~1{tenantId}~1previewTemplate/post/requestBody","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The domain_name to use to for record lookup"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/payments/{tenantId}/previewTemplate","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PreviewTemplateRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/payments/{tenantId}/previewTemplate","href":"payments/previewtemplate","openApiOperationId":"previewTemplate","summary":"Sends out a preview of the notification template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/PreviewTemplateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PreviewTemplateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The record was retrieved successfully","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"Unable to locate any organizations with the specified domain","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1payments~1{tenantId}~1previewTemplate/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payments/previewtemplate"}],"panels":[]}]},"httpPath":"/payments/{tenantId}/previewTemplate"},{"label":"Generates a PDF and returns the public link for download","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/payments/downloadpdf","routeSlug":"/apis/collect/collect-v1/payments/downloadpdf","metadata":{"seo":{"title":"Generates a PDF and returns the public link for download","description":"Generates a PDF and returns the public link for download"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadPdf","name":"Generates a PDF and returns the public link for download","isWebhook":false,"pointer":"/paths/~1payments~1{tenantId}~1print~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Generates a PDF and returns the public link for download","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Generates a PDF and returns the public link for download"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the payment to return","required":true}],"pointer":"/paths/~1payments~1{tenantId}~1print~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"downloadAsHtml","in":"query","schemaId":"schema_428","description":"If true, return the receipt as HTML"}],"pointer":"/paths/~1payments~1{tenantId}~1print~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/payments/{tenantId}/print/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"downloadAsHtml","in":"query","required":false,"schemaId":"schema_428"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/payments/{tenantId}/print/{id}","href":"payments/downloadpdf","openApiOperationId":"downloadPdf","summary":"Generates a PDF and returns the public link for download"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The payment was downloaded successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}},"schemaId":"schema_409","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The payment could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve payment based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1payments~1{tenantId}~1print~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_409","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payments/downloadpdf"}],"panels":[]}]},"httpPath":"/payments/{tenantId}/print/{id}"},{"label":"Processes a public payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/payments/processpublicpayment","routeSlug":"/apis/collect/collect-v1/payments/processpublicpayment","metadata":{"seo":{"title":"Processes a public payment","description":"Allows for publicly payable invoices by taking a payment and processing it anonymously"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"processPublicPayment","name":"Processes a public payment","isWebhook":false,"pointer":"/paths/~1payments~1{tenantId}~1public/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Processes a public payment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Allows for publicly payable invoices by taking a payment and processing it anonymously"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed","required":true}],"pointer":"/paths/~1payments~1{tenantId}~1public/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PublicPaymentRequest"}},"schemaId":"components/schemas/PublicPaymentRequest","pointer":"/paths/~1payments~1{tenantId}~1public/post/requestBody","description":"Payment information"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/payments/{tenantId}/public","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/PublicPaymentRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/payments/{tenantId}/public","href":"payments/processpublicpayment","openApiOperationId":"processPublicPayment","summary":"Processes a public payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/PublicPaymentRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PublicPaymentRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The payment process was started","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StepFunctionExecutionToken"}},"schemaId":"components/schemas/StepFunctionExecutionToken","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The payment could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve payment based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1payments~1{tenantId}~1public/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/StepFunctionExecutionToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StepFunctionExecutionToken"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payments/processpublicpayment"}],"panels":[]}]},"httpPath":"/payments/{tenantId}/public"},{"label":"Processes a public payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/payments/processpublicpaymentsync","routeSlug":"/apis/collect/collect-v1/payments/processpublicpaymentsync","metadata":{"seo":{"title":"Processes a public payment","description":"Allows for publicly payable invoices by taking a payment and processing it anonymously"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"processPublicPaymentSync","name":"Processes a public payment","isWebhook":false,"pointer":"/paths/~1payments~1{tenantId}~1public~1sync/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Processes a public payment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Allows for publicly payable invoices by taking a payment and processing it anonymously"},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed","required":true}],"pointer":"/paths/~1payments~1{tenantId}~1public~1sync/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PublicPaymentRequest"}},"schemaId":"components/schemas/PublicPaymentRequest","pointer":"/paths/~1payments~1{tenantId}~1public~1sync/post/requestBody","description":"Payment information"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/payments/{tenantId}/public/sync","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/PublicPaymentRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/payments/{tenantId}/public/sync","href":"payments/processpublicpaymentsync","openApiOperationId":"processPublicPaymentSync","summary":"Processes a public payment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/PublicPaymentRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PublicPaymentRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The payment process was started","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Payment"}},"schemaId":"components/schemas/Payment","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The payment could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve payment based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1payments~1{tenantId}~1public~1sync/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Payment","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Payment"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payments/processpublicpaymentsync"}],"panels":[]}]},"httpPath":"/payments/{tenantId}/public/sync"},{"label":"Generates a PDF and returns the public link for download","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/payments/renderpaymentemail","routeSlug":"/apis/collect/collect-v1/payments/renderpaymentemail","metadata":{"seo":{"title":"Generates a PDF and returns the public link for download","description":"Generates a PDF and returns the public link for download"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"renderPaymentEmail","name":"Generates a PDF and returns the public link for download","isWebhook":false,"pointer":"/paths/~1payments~1{tenantId}~1renderEmail~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Generates a PDF and returns the public link for download","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Generates a PDF and returns the public link for download"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the payment to return","required":true}],"pointer":"/paths/~1payments~1{tenantId}~1renderEmail~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/payments/{tenantId}/renderEmail/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/payments/{tenantId}/renderEmail/{id}","href":"payments/renderpaymentemail","openApiOperationId":"renderPaymentEmail","summary":"Generates a PDF and returns the public link for download"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The payment was downloaded successfully","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The payment could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve payment based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1payments~1{tenantId}~1renderEmail~1{id}/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payments/renderpaymentemail"}],"panels":[]}]},"httpPath":"/payments/{tenantId}/renderEmail/{id}"},{"label":"Searches for payments using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/payments/searchforpayments","routeSlug":"/apis/collect/collect-v1/payments/searchforpayments","metadata":{"seo":{"title":"Searches for payments using predefined parameters","description":"Searches for payments using predefined parameters"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchForPayments","name":"Searches for payments using predefined parameters","isWebhook":false,"pointer":"/paths/~1payments~1{tenantId}~1search/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Searches for payments using predefined parameters","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Searches for payments using predefined parameters"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1payments~1{tenantId}~1search/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"The start key for the search, for paging support"},{"name":"fieldsToReturn","in":"query","schemaId":"schema_409","description":"  The fields that you want to retrieve; if omitted, the entire object is returned"}],"pointer":"/paths/~1payments~1{tenantId}~1search/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaymentSearchParameters"}},"schemaId":"components/schemas/PaymentSearchParameters","pointer":"/paths/~1payments~1{tenantId}~1search/post/requestBody","description":"The payment that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/payments/{tenantId}/search","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"},{"name":"fieldsToReturn","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PaymentSearchParameters"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/payments/{tenantId}/search","href":"payments/searchforpayments","openApiOperationId":"searchForPayments","summary":"Searches for payments using predefined parameters"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/PaymentSearchParameters","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PaymentSearchParameters"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The payment search was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedPaymentSearchResults"}},"schemaId":"components/schemas/PagedPaymentSearchResults","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The payment you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The payment could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add payment based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1payments~1{tenantId}~1search/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PagedPaymentSearchResults","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedPaymentSearchResults"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payments/searchforpayments"}],"panels":[]}]},"httpPath":"/payments/{tenantId}/search"},{"label":"This is a synchronous processing and should be used exclusively. The old way (via step function) is deprecated.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/payments/processpaymentsync","routeSlug":"/apis/collect/collect-v1/payments/processpaymentsync","metadata":{"seo":{"title":"This is a synchronous processing and should be used exclusively. The old way (via step function) is deprecated.","description":"Processes an payment"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"processPaymentSync","name":"This is a synchronous processing and should be used exclusively. The old way (via step function) is deprecated.","isWebhook":false,"pointer":"/paths/~1payments~1{tenantId}~1sync/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"This is a synchronous processing and should be used exclusively. The old way (via step function) is deprecated.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Processes an payment"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1payments~1{tenantId}~1sync/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Payment"}},"schemaId":"components/schemas/Payment","pointer":"/paths/~1payments~1{tenantId}~1sync/post/requestBody","description":"The payment that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/payments/{tenantId}/sync","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Payment"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/payments/{tenantId}/sync","href":"payments/processpaymentsync","openApiOperationId":"processPaymentSync","summary":"This is a synchronous processing and should be used exclusively. The old way (via step function) is deprecated."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Payment","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Payment"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The operation completed successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Payment"}},"schemaId":"components/schemas/Payment","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The payment you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The payment could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add payment based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1payments~1{tenantId}~1sync/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Payment","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Payment"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payments/processpaymentsync"}],"panels":[]}]},"httpPath":"/payments/{tenantId}/sync"},{"label":"Returns a payment from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/payments/deletepayment","routeSlug":"/apis/collect/collect-v1/payments/deletepayment","metadata":{"seo":{"title":"Returns a payment from the system by its ID.","description":"This method will delete a payment with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deletePayment","name":"Returns a payment from the system by its ID.","isWebhook":false,"pointer":"/paths/~1payments~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a payment from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a payment with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the payment to delete.","required":true}],"pointer":"/paths/~1payments~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/payments/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/payments/{tenantId}/{id}","href":"payments/deletepayment","openApiOperationId":"deletePayment","summary":"Returns a payment from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The payment was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}},"schemaId":"schema_409","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The payment could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The payment could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to delete payment based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1payments~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_409","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payments/deletepayment"}],"panels":[]}]},"httpPath":"/payments/{tenantId}/{id}"},{"label":"Returns a payment from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/payments/getpayment","routeSlug":"/apis/collect/collect-v1/payments/getpayment","metadata":{"seo":{"title":"Returns a payment from the system by its ID.","description":"This method will look up a payment by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPayment","name":"Returns a payment from the system by its ID.","isWebhook":false,"pointer":"/paths/~1payments~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a payment from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a payment by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the payment to return.","required":true}],"pointer":"/paths/~1payments~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_409","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1payments~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/payments/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/payments/{tenantId}/{id}","href":"payments/getpayment","openApiOperationId":"getPayment","summary":"Returns a payment from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The payment was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Payment"}},"schemaId":"components/schemas/Payment","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The payment could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve payment based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1payments~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Payment","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Payment"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payments/getpayment"}],"panels":[]}]},"httpPath":"/payments/{tenantId}/{id}"},{"label":"Partially updates a payment with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/payments/patchpayment","routeSlug":"/apis/collect/collect-v1/payments/patchpayment","metadata":{"seo":{"title":"Partially updates a payment with the specified ID.","description":"This method will patch an existing payment with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchPayment","name":"Partially updates a payment with the specified ID.","isWebhook":false,"pointer":"/paths/~1payments~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a payment with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing payment with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the payment to patch.","required":true}],"pointer":"/paths/~1payments~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"schemaId":"schema_412","pointer":"/paths/~1payments~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/payments/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_412"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/payments/{tenantId}/{id}","href":"payments/patchpayment","openApiOperationId":"patchPayment","summary":"Partially updates a payment with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"schema_412","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The payment was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Payment"}},"schemaId":"components/schemas/Payment","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The payment could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The payment could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve payment based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1payments~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Payment","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Payment"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payments/patchpayment"}],"panels":[]}]},"httpPath":"/payments/{tenantId}/{id}"},{"label":"Updates a payment with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/payments/updatepayment","routeSlug":"/apis/collect/collect-v1/payments/updatepayment","metadata":{"seo":{"title":"Updates a payment with the specified ID.","description":"This method will update an existing payment with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updatePayment","name":"Updates a payment with the specified ID.","isWebhook":false,"pointer":"/paths/~1payments~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a payment with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing payment with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the payment to update.","required":true}],"pointer":"/paths/~1payments~1{tenantId}~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/Payment"}},"schemaId":"components/schemas/Payment","pointer":"/paths/~1payments~1{tenantId}~1{id}/put/requestBody","description":"The updated payment that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/payments/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Payment"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/payments/{tenantId}/{id}","href":"payments/updatepayment","openApiOperationId":"updatePayment","summary":"Updates a payment with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Payment","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Payment"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The payment was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Payment"}},"schemaId":"components/schemas/Payment","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The payment supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The payment could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The payment could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve payment based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1payments~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Payment","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Payment"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payments/updatepayment"}],"panels":[]}]},"httpPath":"/payments/{tenantId}/{id}"},{"label":"Initiates a payment reversal","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/payments/reversepaymentsync","routeSlug":"/apis/collect/collect-v1/payments/reversepaymentsync","metadata":{"seo":{"title":"Initiates a payment reversal","description":"This method will start a reversal payment process"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"reversePaymentSync","name":"Initiates a payment reversal","isWebhook":false,"pointer":"/paths/~1payments~1{tenantId}~1{id}~1reverse~1sync~1{batch_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Initiates a payment reversal","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will start a reversal payment process"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the payment to update","required":true},{"name":"batch_id","in":"path","schemaId":"schema_409","description":"The ID of the batch that the reversal should be placed","required":true}],"pointer":"/paths/~1payments~1{tenantId}~1{id}~1reverse~1sync~1{batch_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_450"}},"schemaId":"schema_450","pointer":"/paths/~1payments~1{tenantId}~1{id}~1reverse~1sync~1{batch_id}/put/requestBody","description":"The memo that explains the reversal"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/payments/{tenantId}/{id}/reverse/sync/{batch_id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"},{"name":"batch_id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_450"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/payments/{tenantId}/{id}/reverse/sync/{batch_id}","href":"payments/reversepaymentsync","openApiOperationId":"reversePaymentSync","summary":"Initiates a payment reversal"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"schema_450","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_450"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The payment reversal was started successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Payment"}},"schemaId":"components/schemas/Payment","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The payment record you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The payment could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The payment could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to update payment based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1payments~1{tenantId}~1{id}~1reverse~1sync~1{batch_id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Payment","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Payment"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payments/reversepaymentsync"}],"panels":[]}]},"httpPath":"/payments/{tenantId}/{id}/reverse/sync/{batch_id}"},{"label":"Initiates a payment reversal","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/payments/reversepayment","routeSlug":"/apis/collect/collect-v1/payments/reversepayment","metadata":{"seo":{"title":"Initiates a payment reversal","description":"This method will start a reversal payment process"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"reversePayment","name":"Initiates a payment reversal","isWebhook":false,"pointer":"/paths/~1payments~1{tenantId}~1{id}~1reverse~1{batch_id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Initiates a payment reversal","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will start a reversal payment process"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the payment to update","required":true},{"name":"batch_id","in":"path","schemaId":"schema_409","description":"The ID of the batch that the reversal should be placed","required":true}],"pointer":"/paths/~1payments~1{tenantId}~1{id}~1reverse~1{batch_id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_450"}},"schemaId":"schema_450","pointer":"/paths/~1payments~1{tenantId}~1{id}~1reverse~1{batch_id}/put/requestBody","description":"The memo that explains the reversal"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/payments/{tenantId}/{id}/reverse/{batch_id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"},{"name":"batch_id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_450"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/payments/{tenantId}/{id}/reverse/{batch_id}","href":"payments/reversepayment","openApiOperationId":"reversePayment","summary":"Initiates a payment reversal"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"schema_450","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_450"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The payment reversal was started successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StepFunctionExecutionToken"}},"schemaId":"components/schemas/StepFunctionExecutionToken","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The payment record you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The payment could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The payment could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to update payment based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1payments~1{tenantId}~1{id}~1reverse~1{batch_id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/StepFunctionExecutionToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StepFunctionExecutionToken"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payments/reversepayment"}],"panels":[]}]},"httpPath":"/payments/{tenantId}/{id}/reverse/{batch_id}"},{"label":"Initiates a payment void","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/payments/voidpayment","routeSlug":"/apis/collect/collect-v1/payments/voidpayment","metadata":{"seo":{"title":"Initiates a payment void","description":"This method will start a void payment process"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"voidPayment","name":"Initiates a payment void","isWebhook":false,"pointer":"/paths/~1payments~1{tenantId}~1{id}~1void/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Initiates a payment void","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will start a void payment process"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the payment to update","required":true}],"pointer":"/paths/~1payments~1{tenantId}~1{id}~1void/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/payments/{tenantId}/{id}/void","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/payments/{tenantId}/{id}/void","href":"payments/voidpayment","openApiOperationId":"voidPayment","summary":"Initiates a payment void"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The payment void was started successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StepFunctionExecutionToken"}},"schemaId":"components/schemas/StepFunctionExecutionToken","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The payment record you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The payment could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The payment could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to update payment based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1payments~1{tenantId}~1{id}~1void/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/StepFunctionExecutionToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StepFunctionExecutionToken"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payments/voidpayment"}],"panels":[]}]},"httpPath":"/payments/{tenantId}/{id}/void"},{"label":"Initiates a payment void","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/payments/voidpaymentsync","routeSlug":"/apis/collect/collect-v1/payments/voidpaymentsync","metadata":{"seo":{"title":"Initiates a payment void","description":"This method will start a void payment process"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"voidPaymentSync","name":"Initiates a payment void","isWebhook":false,"pointer":"/paths/~1payments~1{tenantId}~1{id}~1void~1sync/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Initiates a payment void","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will start a void payment process"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the payment to update","required":true}],"pointer":"/paths/~1payments~1{tenantId}~1{id}~1void~1sync/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/payments/{tenantId}/{id}/void/sync","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/payments/{tenantId}/{id}/void/sync","href":"payments/voidpaymentsync","openApiOperationId":"voidPaymentSync","summary":"Initiates a payment void"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The payment void was started successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Payment"}},"schemaId":"components/schemas/Payment","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The payment record you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The payment could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The payment could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to update payment based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1payments~1{tenantId}~1{id}~1void~1sync/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Payment","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Payment"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/payments/voidpaymentsync"}],"panels":[]}]},"httpPath":"/payments/{tenantId}/{id}/void/sync"}],"content":{"contentType":"group","meta":{"name":"Payments"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Payments","showPageActions":true},{"nodeType":"markdoc","content":"Payments"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/payments/defaultTemplate/paymentReceipt","summary":"Returns the default payment template","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payments/getdefaultpaymentreceipttemplate","deprecated":false},{"title":"/payments/defaultTemplateAndEmail/payment","summary":"Returns the default payment template","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payments/getdefaultpaymenttemplateandemail","deprecated":false},{"title":"/payments/warmUpStepFunctions","summary":"Initiates workflow to warm up inventory transactions","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payments/warmupstepfunctions","deprecated":false},{"title":"/payments/{tenantId}","summary":"Processes a payment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payments/processpayment","deprecated":false},{"title":"/payments/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payments/executebatchoperations","deprecated":false},{"title":"/payments/{tenantId}/batch/{batch_id}","summary":"Returns a list of records with the specified batch_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payments/listpaymentsbybatchid","deprecated":false},{"title":"/payments/{tenantId}/contact/{contact_id}","summary":"Returns a list of records with the specified contact_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payments/listpaymentsbycontactid","deprecated":false},{"title":"/payments/{tenantId}/email/{id}","summary":"Emails an HTML version of the payment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payments/emailpayment","deprecated":false},{"title":"/payments/{tenantId}/order/{order_id}","summary":"Returns a list of records with the specified order_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payments/listpaymentsbyorderid","deprecated":false},{"title":"/payments/{tenantId}/organization/{organization_id}","summary":"Returns a list of records with the specified organization_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payments/listpaymentsbyorganizationid","deprecated":false},{"title":"/payments/{tenantId}/owner/{ownerType}/{ownerId}","summary":"Returns a list of records with the specified owner","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payments/listpaymentsbyowner","deprecated":false},{"title":"/payments/{tenantId}/portal/contact/{portalContactId}","summary":"Gets all of the payments in the system for a given contact.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payments/listpaymentsforportal","deprecated":false},{"title":"/payments/{tenantId}/portal/contact/{portalContactId}/{id}","summary":"Returns a payment from the system by its ID for a given contact.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payments/getpaymentforportal","deprecated":false},{"title":"/payments/{tenantId}/portal/organization/{portalOrganizationId}","summary":"Gets all of the payments in the system for a given organization.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payments/listpaymentsforportalbyorganization","deprecated":false},{"title":"/payments/{tenantId}/portal/organization/{portalOrganizationId}/{id}","summary":"Returns a payment from the system by its ID for a given organization.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payments/getpaymentforportal","deprecated":false},{"title":"/payments/{tenantId}/previewEmail","summary":"Sends out a preview of the CRC notification email","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payments/previewemail","deprecated":false},{"title":"/payments/{tenantId}/previewTemplate","summary":"Sends out a preview of the notification template","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payments/previewtemplate","deprecated":false},{"title":"/payments/{tenantId}/print/{id}","summary":"Generates a PDF and returns the public link for download","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payments/downloadpdf","deprecated":false},{"title":"/payments/{tenantId}/public","summary":"Processes a public payment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payments/processpublicpayment","deprecated":false},{"title":"/payments/{tenantId}/public/sync","summary":"Processes a public payment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payments/processpublicpaymentsync","deprecated":false},{"title":"/payments/{tenantId}/renderEmail/{id}","summary":"Generates a PDF and returns the public link for download","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payments/renderpaymentemail","deprecated":false},{"title":"/payments/{tenantId}/search","summary":"Searches for payments using predefined parameters","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payments/searchforpayments","deprecated":false},{"title":"/payments/{tenantId}/sync","summary":"This is a synchronous processing and should be used exclusively. The old way (via step function) is deprecated.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/payments/processpaymentsync","deprecated":false},{"title":"/payments/{tenantId}/{id}","summary":"Returns a payment from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/payments/deletepayment","deprecated":false},{"title":"/payments/{tenantId}/{id}","summary":"Returns a payment from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/payments/getpayment","deprecated":false},{"title":"/payments/{tenantId}/{id}","summary":"Partially updates a payment with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/payments/patchpayment","deprecated":false},{"title":"/payments/{tenantId}/{id}","summary":"Updates a payment with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/payments/updatepayment","deprecated":false},{"title":"/payments/{tenantId}/{id}/reverse/sync/{batch_id}","summary":"Initiates a payment reversal","prefix":{"name":"put","color":"put"},"badges":[],"link":"/payments/reversepaymentsync","deprecated":false},{"title":"/payments/{tenantId}/{id}/reverse/{batch_id}","summary":"Initiates a payment reversal","prefix":{"name":"put","color":"put"},"badges":[],"link":"/payments/reversepayment","deprecated":false},{"title":"/payments/{tenantId}/{id}/void","summary":"Initiates a payment void","prefix":{"name":"put","color":"put"},"badges":[],"link":"/payments/voidpayment","deprecated":false},{"title":"/payments/{tenantId}/{id}/void/sync","summary":"Initiates a payment void","prefix":{"name":"put","color":"put"},"badges":[],"link":"/payments/voidpaymentsync","deprecated":false}]}]}]}]}},{"type":"group","label":"Product Financial Configs","link":"/apis/collect/collect-v1/product-financial-configs","routeSlug":"/apis/collect/collect-v1/product-financial-configs","items":[{"label":"Gets all of the product financial configs in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/product-financial-configs/listproductfinancialconfigs","routeSlug":"/apis/collect/collect-v1/product-financial-configs/listproductfinancialconfigs","metadata":{"seo":{"title":"Gets all of the product financial configs in the system.","description":"This method will scan all product financial configs and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listProductFinancialConfigs","name":"Gets all of the product financial configs in the system.","isWebhook":false,"pointer":"/paths/~1productFinancialConfigs~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the product financial configs in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all product financial configs and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1productFinancialConfigs~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1productFinancialConfigs~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/productFinancialConfigs/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/productFinancialConfigs/{tenantId}","href":"product-financial-configs/listproductfinancialconfigs","openApiOperationId":"listProductFinancialConfigs","summary":"Gets all of the product financial configs in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The product financial configswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_451"}},"schemaId":"schema_451","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1productFinancialConfigs~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_451","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_451"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/product-financial-configs/listproductfinancialconfigs"}],"panels":[]}]},"httpPath":"/productFinancialConfigs/{tenantId}"},{"label":"Creates a new product financial config record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/product-financial-configs/createproductfinancialconfig","routeSlug":"/apis/collect/collect-v1/product-financial-configs/createproductfinancialconfig","metadata":{"seo":{"title":"Creates a new product financial config record that does not already exist.","description":"This method will auto-generate an ID and create a new product financial config. If an ID is specified for the product financial config, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createProductFinancialConfig","name":"Creates a new product financial config record that does not already exist.","isWebhook":false,"pointer":"/paths/~1productFinancialConfigs~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new product financial config record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new product financial config. If an ID is specified for the product financial config, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1productFinancialConfigs~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ProductFinancialConfig"}},"schemaId":"components/schemas/ProductFinancialConfig","pointer":"/paths/~1productFinancialConfigs~1{tenantId}/post/requestBody","description":"The product financial config that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/productFinancialConfigs/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ProductFinancialConfig"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/productFinancialConfigs/{tenantId}","href":"product-financial-configs/createproductfinancialconfig","openApiOperationId":"createProductFinancialConfig","summary":"Creates a new product financial config record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ProductFinancialConfig","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ProductFinancialConfig"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The product financial config was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProductFinancialConfig"}},"schemaId":"components/schemas/ProductFinancialConfig","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The product financial config you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The product financial config could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add product financial config based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1productFinancialConfigs~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProductFinancialConfig","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProductFinancialConfig"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/product-financial-configs/createproductfinancialconfig"}],"panels":[]}]},"httpPath":"/productFinancialConfigs/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/product-financial-configs/executebatchoperations","routeSlug":"/apis/collect/collect-v1/product-financial-configs/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1productFinancialConfigs~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1productFinancialConfigs~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1productFinancialConfigs~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/productFinancialConfigs/{tenantId}/batch","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/productFinancialConfigs/{tenantId}/batch","href":"product-financial-configs/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The product financial config could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve product financial config based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1productFinancialConfigs~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/product-financial-configs/executebatchoperations"}],"panels":[]}]},"httpPath":"/productFinancialConfigs/{tenantId}/batch"},{"label":"Returns a product financial configs from the system by its product type/ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/product-financial-configs/getproductfinancialconfigsbyproductid","routeSlug":"/apis/collect/collect-v1/product-financial-configs/getproductfinancialconfigsbyproductid","metadata":{"seo":{"title":"Returns a product financial configs from the system by its product type/ID.","description":"This method will look up a product financial configs by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getProductFinancialConfigsByProductId","name":"Returns a product financial configs from the system by its product type/ID.","isWebhook":false,"pointer":"/paths/~1productFinancialConfigs~1{tenantId}~1product~1{productType}~1{productId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a product financial configs from the system by its product type/ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a product financial configs by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed","required":true},{"name":"productType","in":"path","schemaId":"schema_409","description":"The type of product","required":true},{"name":"productId","in":"path","schemaId":"schema_409","description":"The ID of the product to return","required":true}],"pointer":"/paths/~1productFinancialConfigs~1{tenantId}~1product~1{productType}~1{productId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"consistentRead","in":"query","schemaId":"schema_428","description":"If set to true, a consistent read operation will be executed which is guaranteed to return latest results"}],"pointer":"/paths/~1productFinancialConfigs~1{tenantId}~1product~1{productType}~1{productId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/productFinancialConfigs/{tenantId}/product/{productType}/{productId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"productType","in":"path","required":true,"schemaId":"schema_409"},{"name":"productId","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_428"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/productFinancialConfigs/{tenantId}/product/{productType}/{productId}","href":"product-financial-configs/getproductfinancialconfigsbyproductid","openApiOperationId":"getProductFinancialConfigsByProductId","summary":"Returns a product financial configs from the system by its product type/ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The product financial configuration was retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProductFinancialConfig"}},"schemaId":"components/schemas/ProductFinancialConfig","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The product financial configuration could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve product financial configuration based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1productFinancialConfigs~1{tenantId}~1product~1{productType}~1{productId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProductFinancialConfig","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProductFinancialConfig"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/product-financial-configs/getproductfinancialconfigsbyproductid"}],"panels":[]}]},"httpPath":"/productFinancialConfigs/{tenantId}/product/{productType}/{productId}"},{"label":"Returns a product financial config from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/product-financial-configs/deleteproductfinancialconfig","routeSlug":"/apis/collect/collect-v1/product-financial-configs/deleteproductfinancialconfig","metadata":{"seo":{"title":"Returns a product financial config from the system by its ID.","description":"This method will delete a product financial config with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteProductFinancialConfig","name":"Returns a product financial config from the system by its ID.","isWebhook":false,"pointer":"/paths/~1productFinancialConfigs~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a product financial config from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a product financial config with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the product financial config to delete.","required":true}],"pointer":"/paths/~1productFinancialConfigs~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/productFinancialConfigs/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/productFinancialConfigs/{tenantId}/{id}","href":"product-financial-configs/deleteproductfinancialconfig","openApiOperationId":"deleteProductFinancialConfig","summary":"Returns a product financial config from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The product financial config was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}},"schemaId":"schema_409","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The product financial config could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The product financial config could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to delete product financial config based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1productFinancialConfigs~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_409","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/product-financial-configs/deleteproductfinancialconfig"}],"panels":[]}]},"httpPath":"/productFinancialConfigs/{tenantId}/{id}"},{"label":"Returns a product financial config from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/product-financial-configs/getproductfinancialconfig","routeSlug":"/apis/collect/collect-v1/product-financial-configs/getproductfinancialconfig","metadata":{"seo":{"title":"Returns a product financial config from the system by its ID.","description":"This method will look up a product financial config by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getProductFinancialConfig","name":"Returns a product financial config from the system by its ID.","isWebhook":false,"pointer":"/paths/~1productFinancialConfigs~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a product financial config from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a product financial config by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the product financial config to return.","required":true}],"pointer":"/paths/~1productFinancialConfigs~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_409","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1productFinancialConfigs~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/productFinancialConfigs/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/productFinancialConfigs/{tenantId}/{id}","href":"product-financial-configs/getproductfinancialconfig","openApiOperationId":"getProductFinancialConfig","summary":"Returns a product financial config from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The product financial config was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProductFinancialConfig"}},"schemaId":"components/schemas/ProductFinancialConfig","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The product financial config could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve product financial config based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1productFinancialConfigs~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProductFinancialConfig","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProductFinancialConfig"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/product-financial-configs/getproductfinancialconfig"}],"panels":[]}]},"httpPath":"/productFinancialConfigs/{tenantId}/{id}"},{"label":"Partially updates a product financial config with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/product-financial-configs/patchproductfinancialconfig","routeSlug":"/apis/collect/collect-v1/product-financial-configs/patchproductfinancialconfig","metadata":{"seo":{"title":"Partially updates a product financial config with the specified ID.","description":"This method will patch an existing product financial config with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchProductFinancialConfig","name":"Partially updates a product financial config with the specified ID.","isWebhook":false,"pointer":"/paths/~1productFinancialConfigs~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a product financial config with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing product financial config with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the product financial config to patch.","required":true}],"pointer":"/paths/~1productFinancialConfigs~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"schemaId":"schema_412","pointer":"/paths/~1productFinancialConfigs~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/productFinancialConfigs/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_412"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/productFinancialConfigs/{tenantId}/{id}","href":"product-financial-configs/patchproductfinancialconfig","openApiOperationId":"patchProductFinancialConfig","summary":"Partially updates a product financial config with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"schema_412","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The product financial config was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProductFinancialConfig"}},"schemaId":"components/schemas/ProductFinancialConfig","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The product financial config could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The product financial config could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve product financial config based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1productFinancialConfigs~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProductFinancialConfig","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProductFinancialConfig"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/product-financial-configs/patchproductfinancialconfig"}],"panels":[]}]},"httpPath":"/productFinancialConfigs/{tenantId}/{id}"},{"label":"Updates a product financial config with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/product-financial-configs/updateproductfinancialconfig","routeSlug":"/apis/collect/collect-v1/product-financial-configs/updateproductfinancialconfig","metadata":{"seo":{"title":"Updates a product financial config with the specified ID.","description":"This method will update an existing product financial config with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateProductFinancialConfig","name":"Updates a product financial config with the specified ID.","isWebhook":false,"pointer":"/paths/~1productFinancialConfigs~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a product financial config with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing product financial config with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the product financial config to update.","required":true}],"pointer":"/paths/~1productFinancialConfigs~1{tenantId}~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/ProductFinancialConfig"}},"schemaId":"components/schemas/ProductFinancialConfig","pointer":"/paths/~1productFinancialConfigs~1{tenantId}~1{id}/put/requestBody","description":"The updated product financial config that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/productFinancialConfigs/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ProductFinancialConfig"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/productFinancialConfigs/{tenantId}/{id}","href":"product-financial-configs/updateproductfinancialconfig","openApiOperationId":"updateProductFinancialConfig","summary":"Updates a product financial config with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/ProductFinancialConfig","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ProductFinancialConfig"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The product financial config was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProductFinancialConfig"}},"schemaId":"components/schemas/ProductFinancialConfig","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The product financial config supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The product financial config could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The product financial config could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve product financial config based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1productFinancialConfigs~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProductFinancialConfig","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProductFinancialConfig"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/product-financial-configs/updateproductfinancialconfig"}],"panels":[]}]},"httpPath":"/productFinancialConfigs/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Product Financial Configs"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Product Financial Configs","showPageActions":true},{"nodeType":"markdoc","content":"Product Financial Configs"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/productFinancialConfigs/{tenantId}","summary":"Gets all of the product financial configs in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/product-financial-configs/listproductfinancialconfigs","deprecated":false},{"title":"/productFinancialConfigs/{tenantId}","summary":"Creates a new product financial config record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/product-financial-configs/createproductfinancialconfig","deprecated":false},{"title":"/productFinancialConfigs/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/product-financial-configs/executebatchoperations","deprecated":false},{"title":"/productFinancialConfigs/{tenantId}/product/{productType}/{productId}","summary":"Returns a product financial configs from the system by its product type/ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/product-financial-configs/getproductfinancialconfigsbyproductid","deprecated":false},{"title":"/productFinancialConfigs/{tenantId}/{id}","summary":"Returns a product financial config from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/product-financial-configs/deleteproductfinancialconfig","deprecated":false},{"title":"/productFinancialConfigs/{tenantId}/{id}","summary":"Returns a product financial config from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/product-financial-configs/getproductfinancialconfig","deprecated":false},{"title":"/productFinancialConfigs/{tenantId}/{id}","summary":"Partially updates a product financial config with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/product-financial-configs/patchproductfinancialconfig","deprecated":false},{"title":"/productFinancialConfigs/{tenantId}/{id}","summary":"Updates a product financial config with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/product-financial-configs/updateproductfinancialconfig","deprecated":false}]}]}]}]}},{"type":"group","label":"Query Definitions","link":"/apis/collect/collect-v1/query-definitions","routeSlug":"/apis/collect/collect-v1/query-definitions","items":[{"label":"Returns a list of records","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/query-definitions/getquerydefinitions","routeSlug":"/apis/collect/collect-v1/query-definitions/getquerydefinitions","metadata":{"seo":{"title":"Returns a list of records","description":"Returns a list of records"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getQueryDefinitions","name":"Returns a list of records","isWebhook":false,"pointer":"/paths/~1queryDefinitions~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records","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 records"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The tenant","required":true}],"pointer":"/paths/~1queryDefinitions~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/queryDefinitions/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/queryDefinitions/{tenantId}","href":"query-definitions/getquerydefinitions","openApiOperationId":"getQueryDefinitions","summary":"Returns a list of records"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListStandardQueryDefinitionsResponse"}},"schemaId":"components/schemas/ListStandardQueryDefinitionsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1queryDefinitions~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListStandardQueryDefinitionsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListStandardQueryDefinitionsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/query-definitions/getquerydefinitions"}],"panels":[]}]},"httpPath":"/queryDefinitions/{tenantId}"}],"content":{"contentType":"group","meta":{"name":"Query Definitions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Query Definitions","showPageActions":true},{"nodeType":"markdoc","content":"Query Definitions"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/queryDefinitions/{tenantId}","summary":"Returns a list of records","prefix":{"name":"get","color":"get"},"badges":[],"link":"/query-definitions/getquerydefinitions","deprecated":false}]}]}]}]}},{"type":"group","label":"Recurring Batches","link":"/apis/collect/collect-v1/recurring-batches","routeSlug":"/apis/collect/collect-v1/recurring-batches","items":[{"label":"Gets all of the recurring batches in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/recurring-batches/listrecurringbatches","routeSlug":"/apis/collect/collect-v1/recurring-batches/listrecurringbatches","metadata":{"seo":{"title":"Gets all of the recurring batches in the system.","description":"This method will scan all recurring batches and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listRecurringBatches","name":"Gets all of the recurring batches in the system.","isWebhook":false,"pointer":"/paths/~1recurringBatches~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the recurring batches in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all recurring batches and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1recurringBatches~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1recurringBatches~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/recurringBatches/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/recurringBatches/{tenantId}","href":"recurring-batches/listrecurringbatches","openApiOperationId":"listRecurringBatches","summary":"Gets all of the recurring batches in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The recurring batcheswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_452"}},"schemaId":"schema_452","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1recurringBatches~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_452","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_452"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/recurring-batches/listrecurringbatches"}],"panels":[]}]},"httpPath":"/recurringBatches/{tenantId}"},{"label":"Creates a new recurring batch record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/recurring-batches/createrecurringbatch","routeSlug":"/apis/collect/collect-v1/recurring-batches/createrecurringbatch","metadata":{"seo":{"title":"Creates a new recurring batch record that does not already exist.","description":"This method will auto-generate an ID and create a new recurring batch. If an ID is specified for the recurring batch, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createRecurringBatch","name":"Creates a new recurring batch record that does not already exist.","isWebhook":false,"pointer":"/paths/~1recurringBatches~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new recurring batch record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new recurring batch. If an ID is specified for the recurring batch, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1recurringBatches~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RecurringBatch"}},"schemaId":"components/schemas/RecurringBatch","pointer":"/paths/~1recurringBatches~1{tenantId}/post/requestBody","description":"The recurring batch that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/recurringBatches/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RecurringBatch"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/recurringBatches/{tenantId}","href":"recurring-batches/createrecurringbatch","openApiOperationId":"createRecurringBatch","summary":"Creates a new recurring batch record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/RecurringBatch","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RecurringBatch"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The recurring batch was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RecurringBatch"}},"schemaId":"components/schemas/RecurringBatch","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The recurring batch you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The recurring batch could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add recurring batch based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1recurringBatches~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RecurringBatch","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RecurringBatch"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/recurring-batches/createrecurringbatch"}],"panels":[]}]},"httpPath":"/recurringBatches/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/recurring-batches/executebatchoperations","routeSlug":"/apis/collect/collect-v1/recurring-batches/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1recurringBatches~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1recurringBatches~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1recurringBatches~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/recurringBatches/{tenantId}/batch","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/recurringBatches/{tenantId}/batch","href":"recurring-batches/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The recurring batch could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve recurring batch based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1recurringBatches~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/recurring-batches/executebatchoperations"}],"panels":[]}]},"httpPath":"/recurringBatches/{tenantId}/batch"},{"label":"Returns a recurring batch from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/recurring-batches/deleterecurringbatch","routeSlug":"/apis/collect/collect-v1/recurring-batches/deleterecurringbatch","metadata":{"seo":{"title":"Returns a recurring batch from the system by its ID.","description":"This method will delete a recurring batch with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteRecurringBatch","name":"Returns a recurring batch from the system by its ID.","isWebhook":false,"pointer":"/paths/~1recurringBatches~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a recurring batch from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a recurring batch with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the recurring batch to delete.","required":true}],"pointer":"/paths/~1recurringBatches~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/recurringBatches/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/recurringBatches/{tenantId}/{id}","href":"recurring-batches/deleterecurringbatch","openApiOperationId":"deleteRecurringBatch","summary":"Returns a recurring batch from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The recurring batch was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}},"schemaId":"schema_409","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The recurring batch could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The recurring batch could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to delete recurring batch based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1recurringBatches~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_409","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/recurring-batches/deleterecurringbatch"}],"panels":[]}]},"httpPath":"/recurringBatches/{tenantId}/{id}"},{"label":"Returns a recurring batch from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/recurring-batches/getrecurringbatch","routeSlug":"/apis/collect/collect-v1/recurring-batches/getrecurringbatch","metadata":{"seo":{"title":"Returns a recurring batch from the system by its ID.","description":"This method will look up a recurring batch by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getRecurringBatch","name":"Returns a recurring batch from the system by its ID.","isWebhook":false,"pointer":"/paths/~1recurringBatches~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a recurring batch from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a recurring batch by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the recurring batch to return.","required":true}],"pointer":"/paths/~1recurringBatches~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_409","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1recurringBatches~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/recurringBatches/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/recurringBatches/{tenantId}/{id}","href":"recurring-batches/getrecurringbatch","openApiOperationId":"getRecurringBatch","summary":"Returns a recurring batch from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The recurring batch was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RecurringBatch"}},"schemaId":"components/schemas/RecurringBatch","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The recurring batch could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve recurring batch based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1recurringBatches~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RecurringBatch","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RecurringBatch"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/recurring-batches/getrecurringbatch"}],"panels":[]}]},"httpPath":"/recurringBatches/{tenantId}/{id}"},{"label":"Partially updates a recurring batch with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/recurring-batches/patchrecurringbatch","routeSlug":"/apis/collect/collect-v1/recurring-batches/patchrecurringbatch","metadata":{"seo":{"title":"Partially updates a recurring batch with the specified ID.","description":"This method will patch an existing recurring batch with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchRecurringBatch","name":"Partially updates a recurring batch with the specified ID.","isWebhook":false,"pointer":"/paths/~1recurringBatches~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a recurring batch with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing recurring batch with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the recurring batch to patch.","required":true}],"pointer":"/paths/~1recurringBatches~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"schemaId":"schema_412","pointer":"/paths/~1recurringBatches~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/recurringBatches/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_412"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/recurringBatches/{tenantId}/{id}","href":"recurring-batches/patchrecurringbatch","openApiOperationId":"patchRecurringBatch","summary":"Partially updates a recurring batch with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"schema_412","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The recurring batch was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RecurringBatch"}},"schemaId":"components/schemas/RecurringBatch","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The recurring batch could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The recurring batch could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve recurring batch based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1recurringBatches~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RecurringBatch","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RecurringBatch"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/recurring-batches/patchrecurringbatch"}],"panels":[]}]},"httpPath":"/recurringBatches/{tenantId}/{id}"},{"label":"Updates a recurring batch with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/recurring-batches/updaterecurringbatch","routeSlug":"/apis/collect/collect-v1/recurring-batches/updaterecurringbatch","metadata":{"seo":{"title":"Updates a recurring batch with the specified ID.","description":"This method will update an existing recurring batch with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateRecurringBatch","name":"Updates a recurring batch with the specified ID.","isWebhook":false,"pointer":"/paths/~1recurringBatches~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a recurring batch with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing recurring batch with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the recurring batch to update.","required":true}],"pointer":"/paths/~1recurringBatches~1{tenantId}~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/RecurringBatch"}},"schemaId":"components/schemas/RecurringBatch","pointer":"/paths/~1recurringBatches~1{tenantId}~1{id}/put/requestBody","description":"The updated recurring batch that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/recurringBatches/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RecurringBatch"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/recurringBatches/{tenantId}/{id}","href":"recurring-batches/updaterecurringbatch","openApiOperationId":"updateRecurringBatch","summary":"Updates a recurring batch with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/RecurringBatch","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RecurringBatch"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The recurring batch was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RecurringBatch"}},"schemaId":"components/schemas/RecurringBatch","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The recurring batch supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The recurring batch could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The recurring batch could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve recurring batch based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1recurringBatches~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RecurringBatch","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RecurringBatch"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/recurring-batches/updaterecurringbatch"}],"panels":[]}]},"httpPath":"/recurringBatches/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Recurring Batches"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Recurring Batches","showPageActions":true},{"nodeType":"markdoc","content":"Recurring Batches"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/recurringBatches/{tenantId}","summary":"Gets all of the recurring batches in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/recurring-batches/listrecurringbatches","deprecated":false},{"title":"/recurringBatches/{tenantId}","summary":"Creates a new recurring batch record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/recurring-batches/createrecurringbatch","deprecated":false},{"title":"/recurringBatches/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/recurring-batches/executebatchoperations","deprecated":false},{"title":"/recurringBatches/{tenantId}/{id}","summary":"Returns a recurring batch from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/recurring-batches/deleterecurringbatch","deprecated":false},{"title":"/recurringBatches/{tenantId}/{id}","summary":"Returns a recurring batch from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/recurring-batches/getrecurringbatch","deprecated":false},{"title":"/recurringBatches/{tenantId}/{id}","summary":"Partially updates a recurring batch with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/recurring-batches/patchrecurringbatch","deprecated":false},{"title":"/recurringBatches/{tenantId}/{id}","summary":"Updates a recurring batch with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/recurring-batches/updaterecurringbatch","deprecated":false}]}]}]}]}},{"type":"group","label":"Recurring Billing Runs","link":"/apis/collect/collect-v1/recurring-billing-runs","routeSlug":"/apis/collect/collect-v1/recurring-billing-runs","items":[{"label":"Gets all of the recurring billing runs in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/recurring-billing-runs/listrecurringbillingruns","routeSlug":"/apis/collect/collect-v1/recurring-billing-runs/listrecurringbillingruns","metadata":{"seo":{"title":"Gets all of the recurring billing runs in the system.","description":"This method will scan all recurring billing runs and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listRecurringBillingRuns","name":"Gets all of the recurring billing runs in the system.","isWebhook":false,"pointer":"/paths/~1recurringBillingRuns~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the recurring billing runs in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all recurring billing runs and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1recurringBillingRuns~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1recurringBillingRuns~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/recurringBillingRuns/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/recurringBillingRuns/{tenantId}","href":"recurring-billing-runs/listrecurringbillingruns","openApiOperationId":"listRecurringBillingRuns","summary":"Gets all of the recurring billing runs in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The recurring billing runswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_453"}},"schemaId":"schema_453","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1recurringBillingRuns~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_453","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_453"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/recurring-billing-runs/listrecurringbillingruns"}],"panels":[]}]},"httpPath":"/recurringBillingRuns/{tenantId}"},{"label":"Creates a new recurring billing run record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/recurring-billing-runs/createrecurringbillingrun","routeSlug":"/apis/collect/collect-v1/recurring-billing-runs/createrecurringbillingrun","metadata":{"seo":{"title":"Creates a new recurring billing run record that does not already exist.","description":"This method will auto-generate an ID and create a new recurring billing run. If an ID is specified for the recurring billing run, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createRecurringBillingRun","name":"Creates a new recurring billing run record that does not already exist.","isWebhook":false,"pointer":"/paths/~1recurringBillingRuns~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new recurring billing run record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new recurring billing run. If an ID is specified for the recurring billing run, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1recurringBillingRuns~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RecurringBillingRun"}},"schemaId":"components/schemas/RecurringBillingRun","pointer":"/paths/~1recurringBillingRuns~1{tenantId}/post/requestBody","description":"The recurring billing run that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/recurringBillingRuns/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RecurringBillingRun"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/recurringBillingRuns/{tenantId}","href":"recurring-billing-runs/createrecurringbillingrun","openApiOperationId":"createRecurringBillingRun","summary":"Creates a new recurring billing run record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/RecurringBillingRun","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RecurringBillingRun"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The recurring billing run was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RecurringBillingRun"}},"schemaId":"components/schemas/RecurringBillingRun","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The recurring billing run you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The recurring billing run could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add recurring billing run based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1recurringBillingRuns~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RecurringBillingRun","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RecurringBillingRun"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/recurring-billing-runs/createrecurringbillingrun"}],"panels":[]}]},"httpPath":"/recurringBillingRuns/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/recurring-billing-runs/executebatchoperations","routeSlug":"/apis/collect/collect-v1/recurring-billing-runs/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1recurringBillingRuns~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1recurringBillingRuns~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1recurringBillingRuns~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/recurringBillingRuns/{tenantId}/batch","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/recurringBillingRuns/{tenantId}/batch","href":"recurring-billing-runs/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The recurring billing run could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve recurring billing run based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1recurringBillingRuns~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/recurring-billing-runs/executebatchoperations"}],"panels":[]}]},"httpPath":"/recurringBillingRuns/{tenantId}/batch"},{"label":"Returns a list of records with the specified template_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/recurring-billing-runs/listrunsbytemplateid","routeSlug":"/apis/collect/collect-v1/recurring-billing-runs/listrunsbytemplateid","metadata":{"seo":{"title":"Returns a list of records with the specified template_id","description":"Returns a list of records with the specified template_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listRunsByTemplateId","name":"Returns a list of records with the specified template_id","isWebhook":false,"pointer":"/paths/~1recurringBillingRuns~1{tenantId}~1template~1{template_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified template_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":"Returns a list of records with the specified template_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The tenant","required":true},{"name":"template_id","in":"path","schemaId":"schema_409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The template_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1recurringBillingRuns~1{tenantId}~1template~1{template_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1recurringBillingRuns~1{tenantId}~1template~1{template_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/recurringBillingRuns/{tenantId}/template/{template_id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"template_id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/recurringBillingRuns/{tenantId}/template/{template_id}","href":"recurring-billing-runs/listrunsbytemplateid","openApiOperationId":"listRunsByTemplateId","summary":"Returns a list of records with the specified template_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListRecurringBillingRunsResponse"}},"schemaId":"components/schemas/ListRecurringBillingRunsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1recurringBillingRuns~1{tenantId}~1template~1{template_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListRecurringBillingRunsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListRecurringBillingRunsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/recurring-billing-runs/listrunsbytemplateid"}],"panels":[]}]},"httpPath":"/recurringBillingRuns/{tenantId}/template/{template_id}"},{"label":"Returns a recurring billing run from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/recurring-billing-runs/deleterecurringbillingrun","routeSlug":"/apis/collect/collect-v1/recurring-billing-runs/deleterecurringbillingrun","metadata":{"seo":{"title":"Returns a recurring billing run from the system by its ID.","description":"This method will delete a recurring billing run with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteRecurringBillingRun","name":"Returns a recurring billing run from the system by its ID.","isWebhook":false,"pointer":"/paths/~1recurringBillingRuns~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a recurring billing run from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a recurring billing run with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the recurring billing run to delete.","required":true}],"pointer":"/paths/~1recurringBillingRuns~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/recurringBillingRuns/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/recurringBillingRuns/{tenantId}/{id}","href":"recurring-billing-runs/deleterecurringbillingrun","openApiOperationId":"deleteRecurringBillingRun","summary":"Returns a recurring billing run from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The recurring billing run was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}},"schemaId":"schema_409","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The recurring billing run could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The recurring billing run could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to delete recurring billing run based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1recurringBillingRuns~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_409","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/recurring-billing-runs/deleterecurringbillingrun"}],"panels":[]}]},"httpPath":"/recurringBillingRuns/{tenantId}/{id}"},{"label":"Returns a recurring billing run from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/recurring-billing-runs/getrecurringbillingrun","routeSlug":"/apis/collect/collect-v1/recurring-billing-runs/getrecurringbillingrun","metadata":{"seo":{"title":"Returns a recurring billing run from the system by its ID.","description":"This method will look up a recurring billing run by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getRecurringBillingRun","name":"Returns a recurring billing run from the system by its ID.","isWebhook":false,"pointer":"/paths/~1recurringBillingRuns~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a recurring billing run from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a recurring billing run by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the recurring billing run to return.","required":true}],"pointer":"/paths/~1recurringBillingRuns~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_409","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1recurringBillingRuns~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/recurringBillingRuns/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/recurringBillingRuns/{tenantId}/{id}","href":"recurring-billing-runs/getrecurringbillingrun","openApiOperationId":"getRecurringBillingRun","summary":"Returns a recurring billing run from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The recurring billing run was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RecurringBillingRun"}},"schemaId":"components/schemas/RecurringBillingRun","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The recurring billing run could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve recurring billing run based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1recurringBillingRuns~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RecurringBillingRun","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RecurringBillingRun"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/recurring-billing-runs/getrecurringbillingrun"}],"panels":[]}]},"httpPath":"/recurringBillingRuns/{tenantId}/{id}"},{"label":"Partially updates a recurring billing run with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/recurring-billing-runs/patchrecurringbillingrun","routeSlug":"/apis/collect/collect-v1/recurring-billing-runs/patchrecurringbillingrun","metadata":{"seo":{"title":"Partially updates a recurring billing run with the specified ID.","description":"This method will patch an existing recurring billing run with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchRecurringBillingRun","name":"Partially updates a recurring billing run with the specified ID.","isWebhook":false,"pointer":"/paths/~1recurringBillingRuns~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a recurring billing run with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing recurring billing run with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the recurring billing run to patch.","required":true}],"pointer":"/paths/~1recurringBillingRuns~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"schemaId":"schema_412","pointer":"/paths/~1recurringBillingRuns~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/recurringBillingRuns/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_412"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/recurringBillingRuns/{tenantId}/{id}","href":"recurring-billing-runs/patchrecurringbillingrun","openApiOperationId":"patchRecurringBillingRun","summary":"Partially updates a recurring billing run with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"schema_412","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The recurring billing run was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RecurringBillingRun"}},"schemaId":"components/schemas/RecurringBillingRun","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The recurring billing run could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The recurring billing run could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve recurring billing run based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1recurringBillingRuns~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RecurringBillingRun","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RecurringBillingRun"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/recurring-billing-runs/patchrecurringbillingrun"}],"panels":[]}]},"httpPath":"/recurringBillingRuns/{tenantId}/{id}"},{"label":"Updates a recurring billing run with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/recurring-billing-runs/updaterecurringbillingrun","routeSlug":"/apis/collect/collect-v1/recurring-billing-runs/updaterecurringbillingrun","metadata":{"seo":{"title":"Updates a recurring billing run with the specified ID.","description":"This method will update an existing recurring billing run with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateRecurringBillingRun","name":"Updates a recurring billing run with the specified ID.","isWebhook":false,"pointer":"/paths/~1recurringBillingRuns~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a recurring billing run with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing recurring billing run with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the recurring billing run to update.","required":true}],"pointer":"/paths/~1recurringBillingRuns~1{tenantId}~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/RecurringBillingRun"}},"schemaId":"components/schemas/RecurringBillingRun","pointer":"/paths/~1recurringBillingRuns~1{tenantId}~1{id}/put/requestBody","description":"The updated recurring billing run that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/recurringBillingRuns/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RecurringBillingRun"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/recurringBillingRuns/{tenantId}/{id}","href":"recurring-billing-runs/updaterecurringbillingrun","openApiOperationId":"updateRecurringBillingRun","summary":"Updates a recurring billing run with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/RecurringBillingRun","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RecurringBillingRun"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The recurring billing run was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RecurringBillingRun"}},"schemaId":"components/schemas/RecurringBillingRun","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The recurring billing run supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The recurring billing run could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The recurring billing run could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve recurring billing run based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1recurringBillingRuns~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RecurringBillingRun","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RecurringBillingRun"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/recurring-billing-runs/updaterecurringbillingrun"}],"panels":[]}]},"httpPath":"/recurringBillingRuns/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Recurring Billing Runs"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Recurring Billing Runs","showPageActions":true},{"nodeType":"markdoc","content":"Recurring Billing Runs"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/recurringBillingRuns/{tenantId}","summary":"Gets all of the recurring billing runs in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/recurring-billing-runs/listrecurringbillingruns","deprecated":false},{"title":"/recurringBillingRuns/{tenantId}","summary":"Creates a new recurring billing run record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/recurring-billing-runs/createrecurringbillingrun","deprecated":false},{"title":"/recurringBillingRuns/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/recurring-billing-runs/executebatchoperations","deprecated":false},{"title":"/recurringBillingRuns/{tenantId}/template/{template_id}","summary":"Returns a list of records with the specified template_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/recurring-billing-runs/listrunsbytemplateid","deprecated":false},{"title":"/recurringBillingRuns/{tenantId}/{id}","summary":"Returns a recurring billing run from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/recurring-billing-runs/deleterecurringbillingrun","deprecated":false},{"title":"/recurringBillingRuns/{tenantId}/{id}","summary":"Returns a recurring billing run from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/recurring-billing-runs/getrecurringbillingrun","deprecated":false},{"title":"/recurringBillingRuns/{tenantId}/{id}","summary":"Partially updates a recurring billing run with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/recurring-billing-runs/patchrecurringbillingrun","deprecated":false},{"title":"/recurringBillingRuns/{tenantId}/{id}","summary":"Updates a recurring billing run with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/recurring-billing-runs/updaterecurringbillingrun","deprecated":false}]}]}]}]}},{"type":"group","label":"Refund Receipt Templates","link":"/apis/collect/collect-v1/refund-receipt-templates","routeSlug":"/apis/collect/collect-v1/refund-receipt-templates","items":[{"label":"Gets all of the refund receipt templates in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/refund-receipt-templates/listrefundreceipttemplates","routeSlug":"/apis/collect/collect-v1/refund-receipt-templates/listrefundreceipttemplates","metadata":{"seo":{"title":"Gets all of the refund receipt templates in the system.","description":"This method will scan all refund receipt templates and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listRefundReceiptTemplates","name":"Gets all of the refund receipt templates in the system.","isWebhook":false,"pointer":"/paths/~1refundReceiptTemplates~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the refund receipt templates in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all refund receipt templates and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1refundReceiptTemplates~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1refundReceiptTemplates~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/refundReceiptTemplates/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/refundReceiptTemplates/{tenantId}","href":"refund-receipt-templates/listrefundreceipttemplates","openApiOperationId":"listRefundReceiptTemplates","summary":"Gets all of the refund receipt templates in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The refund receipt templateswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_454"}},"schemaId":"schema_454","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1refundReceiptTemplates~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_454","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_454"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/refund-receipt-templates/listrefundreceipttemplates"}],"panels":[]}]},"httpPath":"/refundReceiptTemplates/{tenantId}"},{"label":"Creates a new refund receipt template record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/refund-receipt-templates/createrefundreceipttemplate","routeSlug":"/apis/collect/collect-v1/refund-receipt-templates/createrefundreceipttemplate","metadata":{"seo":{"title":"Creates a new refund receipt template record that does not already exist.","description":"This method will auto-generate an ID and create a new refund receipt template. If an ID is specified for the refund receipt template, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createRefundReceiptTemplate","name":"Creates a new refund receipt template record that does not already exist.","isWebhook":false,"pointer":"/paths/~1refundReceiptTemplates~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new refund receipt template record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new refund receipt template. If an ID is specified for the refund receipt template, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1refundReceiptTemplates~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RefundReceiptTemplate"}},"schemaId":"components/schemas/RefundReceiptTemplate","pointer":"/paths/~1refundReceiptTemplates~1{tenantId}/post/requestBody","description":"The refund receipt template that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/refundReceiptTemplates/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RefundReceiptTemplate"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/refundReceiptTemplates/{tenantId}","href":"refund-receipt-templates/createrefundreceipttemplate","openApiOperationId":"createRefundReceiptTemplate","summary":"Creates a new refund receipt template record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/RefundReceiptTemplate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RefundReceiptTemplate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The refund receipt template was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RefundReceiptTemplate"}},"schemaId":"components/schemas/RefundReceiptTemplate","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The refund receipt template you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The refund receipt template could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add refund receipt template based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1refundReceiptTemplates~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RefundReceiptTemplate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RefundReceiptTemplate"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/refund-receipt-templates/createrefundreceipttemplate"}],"panels":[]}]},"httpPath":"/refundReceiptTemplates/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/refund-receipt-templates/executebatchoperations","routeSlug":"/apis/collect/collect-v1/refund-receipt-templates/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1refundReceiptTemplates~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1refundReceiptTemplates~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1refundReceiptTemplates~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/refundReceiptTemplates/{tenantId}/batch","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/refundReceiptTemplates/{tenantId}/batch","href":"refund-receipt-templates/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The refund receipt template could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve refund receipt template based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1refundReceiptTemplates~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/refund-receipt-templates/executebatchoperations"}],"panels":[]}]},"httpPath":"/refundReceiptTemplates/{tenantId}/batch"},{"label":"Returns a refund receipt template from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/refund-receipt-templates/deleterefundreceipttemplate","routeSlug":"/apis/collect/collect-v1/refund-receipt-templates/deleterefundreceipttemplate","metadata":{"seo":{"title":"Returns a refund receipt template from the system by its ID.","description":"This method will delete a refund receipt template with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteRefundReceiptTemplate","name":"Returns a refund receipt template from the system by its ID.","isWebhook":false,"pointer":"/paths/~1refundReceiptTemplates~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a refund receipt template from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a refund receipt template with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the refund receipt template to delete.","required":true}],"pointer":"/paths/~1refundReceiptTemplates~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/refundReceiptTemplates/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/refundReceiptTemplates/{tenantId}/{id}","href":"refund-receipt-templates/deleterefundreceipttemplate","openApiOperationId":"deleteRefundReceiptTemplate","summary":"Returns a refund receipt template from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The refund receipt template was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}},"schemaId":"schema_409","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The refund receipt template could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The refund receipt template could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to delete refund receipt template based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1refundReceiptTemplates~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_409","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/refund-receipt-templates/deleterefundreceipttemplate"}],"panels":[]}]},"httpPath":"/refundReceiptTemplates/{tenantId}/{id}"},{"label":"Returns a refund receipt template from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/refund-receipt-templates/getrefundreceipttemplate","routeSlug":"/apis/collect/collect-v1/refund-receipt-templates/getrefundreceipttemplate","metadata":{"seo":{"title":"Returns a refund receipt template from the system by its ID.","description":"This method will look up a refund receipt template by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getRefundReceiptTemplate","name":"Returns a refund receipt template from the system by its ID.","isWebhook":false,"pointer":"/paths/~1refundReceiptTemplates~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a refund receipt template from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a refund receipt template by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the refund receipt template to return.","required":true}],"pointer":"/paths/~1refundReceiptTemplates~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_409","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1refundReceiptTemplates~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/refundReceiptTemplates/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/refundReceiptTemplates/{tenantId}/{id}","href":"refund-receipt-templates/getrefundreceipttemplate","openApiOperationId":"getRefundReceiptTemplate","summary":"Returns a refund receipt template from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The refund receipt template was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RefundReceiptTemplate"}},"schemaId":"components/schemas/RefundReceiptTemplate","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The refund receipt template could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve refund receipt template based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1refundReceiptTemplates~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RefundReceiptTemplate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RefundReceiptTemplate"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/refund-receipt-templates/getrefundreceipttemplate"}],"panels":[]}]},"httpPath":"/refundReceiptTemplates/{tenantId}/{id}"},{"label":"Partially updates a refund receipt template with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/refund-receipt-templates/patchrefundreceipttemplate","routeSlug":"/apis/collect/collect-v1/refund-receipt-templates/patchrefundreceipttemplate","metadata":{"seo":{"title":"Partially updates a refund receipt template with the specified ID.","description":"This method will patch an existing refund receipt template with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchRefundReceiptTemplate","name":"Partially updates a refund receipt template with the specified ID.","isWebhook":false,"pointer":"/paths/~1refundReceiptTemplates~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a refund receipt template with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing refund receipt template with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the refund receipt template to patch.","required":true}],"pointer":"/paths/~1refundReceiptTemplates~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"schemaId":"schema_412","pointer":"/paths/~1refundReceiptTemplates~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/refundReceiptTemplates/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_412"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/refundReceiptTemplates/{tenantId}/{id}","href":"refund-receipt-templates/patchrefundreceipttemplate","openApiOperationId":"patchRefundReceiptTemplate","summary":"Partially updates a refund receipt template with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"schema_412","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The refund receipt template was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RefundReceiptTemplate"}},"schemaId":"components/schemas/RefundReceiptTemplate","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The refund receipt template could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The refund receipt template could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve refund receipt template based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1refundReceiptTemplates~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RefundReceiptTemplate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RefundReceiptTemplate"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/refund-receipt-templates/patchrefundreceipttemplate"}],"panels":[]}]},"httpPath":"/refundReceiptTemplates/{tenantId}/{id}"},{"label":"Updates a refund receipt template with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/refund-receipt-templates/updaterefundreceipttemplate","routeSlug":"/apis/collect/collect-v1/refund-receipt-templates/updaterefundreceipttemplate","metadata":{"seo":{"title":"Updates a refund receipt template with the specified ID.","description":"This method will update an existing refund receipt template with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateRefundReceiptTemplate","name":"Updates a refund receipt template with the specified ID.","isWebhook":false,"pointer":"/paths/~1refundReceiptTemplates~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a refund receipt template with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing refund receipt template with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the refund receipt template to update.","required":true}],"pointer":"/paths/~1refundReceiptTemplates~1{tenantId}~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/RefundReceiptTemplate"}},"schemaId":"components/schemas/RefundReceiptTemplate","pointer":"/paths/~1refundReceiptTemplates~1{tenantId}~1{id}/put/requestBody","description":"The updated refund receipt template that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/refundReceiptTemplates/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RefundReceiptTemplate"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/refundReceiptTemplates/{tenantId}/{id}","href":"refund-receipt-templates/updaterefundreceipttemplate","openApiOperationId":"updateRefundReceiptTemplate","summary":"Updates a refund receipt template with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/RefundReceiptTemplate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RefundReceiptTemplate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The refund receipt template was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RefundReceiptTemplate"}},"schemaId":"components/schemas/RefundReceiptTemplate","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The refund receipt template supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The refund receipt template could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The refund receipt template could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve refund receipt template based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1refundReceiptTemplates~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RefundReceiptTemplate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RefundReceiptTemplate"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/refund-receipt-templates/updaterefundreceipttemplate"}],"panels":[]}]},"httpPath":"/refundReceiptTemplates/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Refund Receipt Templates"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Refund Receipt Templates","showPageActions":true},{"nodeType":"markdoc","content":"Refund Receipt Templates"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/refundReceiptTemplates/{tenantId}","summary":"Gets all of the refund receipt templates in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/refund-receipt-templates/listrefundreceipttemplates","deprecated":false},{"title":"/refundReceiptTemplates/{tenantId}","summary":"Creates a new refund receipt template record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/refund-receipt-templates/createrefundreceipttemplate","deprecated":false},{"title":"/refundReceiptTemplates/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/refund-receipt-templates/executebatchoperations","deprecated":false},{"title":"/refundReceiptTemplates/{tenantId}/{id}","summary":"Returns a refund receipt template from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/refund-receipt-templates/deleterefundreceipttemplate","deprecated":false},{"title":"/refundReceiptTemplates/{tenantId}/{id}","summary":"Returns a refund receipt template from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/refund-receipt-templates/getrefundreceipttemplate","deprecated":false},{"title":"/refundReceiptTemplates/{tenantId}/{id}","summary":"Partially updates a refund receipt template with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/refund-receipt-templates/patchrefundreceipttemplate","deprecated":false},{"title":"/refundReceiptTemplates/{tenantId}/{id}","summary":"Updates a refund receipt template with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/refund-receipt-templates/updaterefundreceipttemplate","deprecated":false}]}]}]}]}},{"type":"group","label":"Refunds","link":"/apis/collect/collect-v1/refunds","routeSlug":"/apis/collect/collect-v1/refunds","items":[{"label":"Returns the default refund template","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/refunds/getdefaultrefundtemplate","routeSlug":"/apis/collect/collect-v1/refunds/getdefaultrefundtemplate","metadata":{"seo":{"title":"Returns the default refund template","description":"Returns the default refund template"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDefaultRefundTemplate","name":"Returns the default refund template","isWebhook":false,"pointer":"/paths/~1refunds~1defaultTemplate~1refund/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns the default refund template","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the default refund template"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/refunds/defaultTemplate/refund","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/refunds/defaultTemplate/refund","href":"refunds/getdefaultrefundtemplate","openApiOperationId":"getDefaultRefundTemplate","summary":"Returns the default refund template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The refund template","mediaType":"text/html","mediaTypes":["text/html"],"mediaTypeContent":{"text/html":{"schemaId":"schema_409"}},"schemaId":"schema_409","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The refund could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve refund based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1refunds~1defaultTemplate~1refund/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_409","mediaTypes":["text/html"],"mediaTypeContent":{"text/html":{"schemaId":"schema_409"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/refunds/getdefaultrefundtemplate"}],"panels":[]}]},"httpPath":"/refunds/defaultTemplate/refund"},{"label":"Initiates workflow to warm up inventory transactions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/refunds/warmupstepfunctions","routeSlug":"/apis/collect/collect-v1/refunds/warmupstepfunctions","metadata":{"seo":{"title":"Initiates workflow to warm up inventory transactions","description":"Initiates workflow to warm up inventory transactions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"warmUpStepFunctions","name":"Initiates workflow to warm up inventory transactions","isWebhook":false,"pointer":"/paths/~1refunds~1warmUpStepFunctions/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Initiates workflow to warm up inventory transactions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/refunds/warmUpStepFunctions","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/refunds/warmUpStepFunctions","href":"refunds/warmupstepfunctions","openApiOperationId":"warmUpStepFunctions","summary":"Initiates workflow to warm up inventory transactions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Request limit exceeded... please try your request again in a few seconds","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"An internal server error occured.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1refunds~1warmUpStepFunctions/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/refunds/warmupstepfunctions"}],"panels":[]}]},"httpPath":"/refunds/warmUpStepFunctions"},{"label":"Gets all of the refunds in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/refunds/listrefunds","routeSlug":"/apis/collect/collect-v1/refunds/listrefunds","metadata":{"seo":{"title":"Gets all of the refunds in the system.","description":"This method will scan all refunds and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listRefunds","name":"Gets all of the refunds in the system.","isWebhook":false,"pointer":"/paths/~1refunds~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the refunds in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all refunds and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1refunds~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1refunds~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/refunds/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/refunds/{tenantId}","href":"refunds/listrefunds","openApiOperationId":"listRefunds","summary":"Gets all of the refunds in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The refundswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_455"}},"schemaId":"schema_455","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1refunds~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_455","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_455"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/refunds/listrefunds"}],"panels":[]}]},"httpPath":"/refunds/{tenantId}"},{"label":"Creates a new refund that doesn't already exist","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/refunds/processrefund","routeSlug":"/apis/collect/collect-v1/refunds/processrefund","metadata":{"seo":{"title":"Creates a new refund that doesn't already exist","description":"This method will auto-generate an ID and create a new refund. If an ID is specified for the refund, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"processRefund","name":"Creates a new refund that doesn't already exist","isWebhook":false,"pointer":"/paths/~1refunds~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new refund that doesn't already exist","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new refund. If an ID is specified for the refund, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1refunds~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Refund"}},"schemaId":"components/schemas/Refund","pointer":"/paths/~1refunds~1{tenantId}/post/requestBody","description":"The refund that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/refunds/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Refund"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/refunds/{tenantId}","href":"refunds/processrefund","openApiOperationId":"processRefund","summary":"Creates a new refund that doesn't already exist"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Refund","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Refund"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The refund was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StepFunctionExecutionToken"}},"schemaId":"components/schemas/StepFunctionExecutionToken","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The refund you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The refund could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add refund based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1refunds~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/StepFunctionExecutionToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StepFunctionExecutionToken"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/refunds/processrefund"}],"panels":[]}]},"httpPath":"/refunds/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/refunds/executebatchoperations","routeSlug":"/apis/collect/collect-v1/refunds/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1refunds~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1refunds~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1refunds~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/refunds/{tenantId}/batch","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/refunds/{tenantId}/batch","href":"refunds/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The refund could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve refund based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1refunds~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/refunds/executebatchoperations"}],"panels":[]}]},"httpPath":"/refunds/{tenantId}/batch"},{"label":"Returns a list of records with the specified batch_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/refunds/listrefundsbybatchid","routeSlug":"/apis/collect/collect-v1/refunds/listrefundsbybatchid","metadata":{"seo":{"title":"Returns a list of records with the specified batch_id","description":"Returns a list of records with the specified batch_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listRefundsByBatchId","name":"Returns a list of records with the specified batch_id","isWebhook":false,"pointer":"/paths/~1refunds~1{tenantId}~1batch~1{batch_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified batch_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":"Returns a list of records with the specified batch_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The tenant","required":true},{"name":"batch_id","in":"path","schemaId":"schema_409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The batch_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1refunds~1{tenantId}~1batch~1{batch_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1refunds~1{tenantId}~1batch~1{batch_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/refunds/{tenantId}/batch/{batch_id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"batch_id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/refunds/{tenantId}/batch/{batch_id}","href":"refunds/listrefundsbybatchid","openApiOperationId":"listRefundsByBatchId","summary":"Returns a list of records with the specified batch_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListRefundsResponse"}},"schemaId":"components/schemas/ListRefundsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1refunds~1{tenantId}~1batch~1{batch_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListRefundsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListRefundsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/refunds/listrefundsbybatchid"}],"panels":[]}]},"httpPath":"/refunds/{tenantId}/batch/{batch_id}"},{"label":"Sends out a preview of the notification template","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/refunds/previewtemplate","routeSlug":"/apis/collect/collect-v1/refunds/previewtemplate","metadata":{"seo":{"title":"Sends out a preview of the notification template","description":"Sends out a preview of the notification template"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"previewTemplate","name":"Sends out a preview of the notification template","isWebhook":false,"pointer":"/paths/~1refunds~1{tenantId}~1previewTemplate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sends out a preview of the notification template","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Sends out a preview of the notification template"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The tenant","required":true}],"pointer":"/paths/~1refunds~1{tenantId}~1previewTemplate/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PreviewTemplateRequest"}},"schemaId":"components/schemas/PreviewTemplateRequest","pointer":"/paths/~1refunds~1{tenantId}~1previewTemplate/post/requestBody","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The domain_name to use to for record lookup"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/refunds/{tenantId}/previewTemplate","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PreviewTemplateRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/refunds/{tenantId}/previewTemplate","href":"refunds/previewtemplate","openApiOperationId":"previewTemplate","summary":"Sends out a preview of the notification template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/PreviewTemplateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PreviewTemplateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The record was retrieved successfully","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"Unable to locate any organizations with the specified domain","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1refunds~1{tenantId}~1previewTemplate/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/refunds/previewtemplate"}],"panels":[]}]},"httpPath":"/refunds/{tenantId}/previewTemplate"},{"label":"Generates a PDF and returns the public link for download","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/refunds/downloadpdf","routeSlug":"/apis/collect/collect-v1/refunds/downloadpdf","metadata":{"seo":{"title":"Generates a PDF and returns the public link for download","description":"Generates a PDF and returns the public link for download"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadPdf","name":"Generates a PDF and returns the public link for download","isWebhook":false,"pointer":"/paths/~1refunds~1{tenantId}~1print~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Generates a PDF and returns the public link for download","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Generates a PDF and returns the public link for download"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the refund to return","required":true}],"pointer":"/paths/~1refunds~1{tenantId}~1print~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"downloadAsHtml","in":"query","schemaId":"schema_428","description":"If true, return the receipt as HTML"}],"pointer":"/paths/~1refunds~1{tenantId}~1print~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/refunds/{tenantId}/print/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"downloadAsHtml","in":"query","required":false,"schemaId":"schema_428"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/refunds/{tenantId}/print/{id}","href":"refunds/downloadpdf","openApiOperationId":"downloadPdf","summary":"Generates a PDF and returns the public link for download"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The refund was downloaded successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}},"schemaId":"schema_409","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The refund could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve refund based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1refunds~1{tenantId}~1print~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_409","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/refunds/downloadpdf"}],"panels":[]}]},"httpPath":"/refunds/{tenantId}/print/{id}"},{"label":"Searches for refunds using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/refunds/searchforrefunds","routeSlug":"/apis/collect/collect-v1/refunds/searchforrefunds","metadata":{"seo":{"title":"Searches for refunds using predefined parameters","description":"Searches for refunds using predefined parameters"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchForRefunds","name":"Searches for refunds using predefined parameters","isWebhook":false,"pointer":"/paths/~1refunds~1{tenantId}~1search/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Searches for refunds using predefined parameters","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Searches for refunds using predefined parameters"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1refunds~1{tenantId}~1search/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"The start key for the search, for paging support"},{"name":"fieldsToReturn","in":"query","schemaId":"schema_409","description":"  The fields that you want to retrieve; if omitted, the entire object is returned"}],"pointer":"/paths/~1refunds~1{tenantId}~1search/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RefundSearchParameters"}},"schemaId":"components/schemas/RefundSearchParameters","pointer":"/paths/~1refunds~1{tenantId}~1search/post/requestBody","description":"The refund that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/refunds/{tenantId}/search","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"},{"name":"fieldsToReturn","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RefundSearchParameters"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/refunds/{tenantId}/search","href":"refunds/searchforrefunds","openApiOperationId":"searchForRefunds","summary":"Searches for refunds using predefined parameters"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/RefundSearchParameters","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RefundSearchParameters"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The refund search was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedRefundSearchResults"}},"schemaId":"components/schemas/PagedRefundSearchResults","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The refund you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The refund could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add refund based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1refunds~1{tenantId}~1search/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PagedRefundSearchResults","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedRefundSearchResults"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/refunds/searchforrefunds"}],"panels":[]}]},"httpPath":"/refunds/{tenantId}/search"},{"label":"Creates a new refund that doesn't already exist","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/refunds/processrefundsync","routeSlug":"/apis/collect/collect-v1/refunds/processrefundsync","metadata":{"seo":{"title":"Creates a new refund that doesn't already exist","description":"This method will auto-generate an ID and create a new refund. If an ID is specified for the refund, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"processRefundSync","name":"Creates a new refund that doesn't already exist","isWebhook":false,"pointer":"/paths/~1refunds~1{tenantId}~1sync/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new refund that doesn't already exist","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new refund. If an ID is specified for the refund, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1refunds~1{tenantId}~1sync/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Refund"}},"schemaId":"components/schemas/Refund","pointer":"/paths/~1refunds~1{tenantId}~1sync/post/requestBody","description":"The refund that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/refunds/{tenantId}/sync","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Refund"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/refunds/{tenantId}/sync","href":"refunds/processrefundsync","openApiOperationId":"processRefundSync","summary":"Creates a new refund that doesn't already exist"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Refund","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Refund"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The refund was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Refund"}},"schemaId":"components/schemas/Refund","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The refund you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The refund could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add refund based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1refunds~1{tenantId}~1sync/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Refund","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Refund"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/refunds/processrefundsync"}],"panels":[]}]},"httpPath":"/refunds/{tenantId}/sync"},{"label":"Returns a refund from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/refunds/getrefund","routeSlug":"/apis/collect/collect-v1/refunds/getrefund","metadata":{"seo":{"title":"Returns a refund from the system by its ID.","description":"This method will look up a refund by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getRefund","name":"Returns a refund from the system by its ID.","isWebhook":false,"pointer":"/paths/~1refunds~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a refund from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a refund by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the refund to return.","required":true}],"pointer":"/paths/~1refunds~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_409","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1refunds~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/refunds/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/refunds/{tenantId}/{id}","href":"refunds/getrefund","openApiOperationId":"getRefund","summary":"Returns a refund from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The refund was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Refund"}},"schemaId":"components/schemas/Refund","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The refund could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve refund based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1refunds~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Refund","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Refund"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/refunds/getrefund"}],"panels":[]}]},"httpPath":"/refunds/{tenantId}/{id}"},{"label":"Partially updates a refund with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/refunds/patchrefund","routeSlug":"/apis/collect/collect-v1/refunds/patchrefund","metadata":{"seo":{"title":"Partially updates a refund with the specified ID.","description":"This method will patch an existing refund with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchRefund","name":"Partially updates a refund with the specified ID.","isWebhook":false,"pointer":"/paths/~1refunds~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a refund with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing refund with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the refund to patch.","required":true}],"pointer":"/paths/~1refunds~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"schemaId":"schema_412","pointer":"/paths/~1refunds~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/refunds/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_412"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/refunds/{tenantId}/{id}","href":"refunds/patchrefund","openApiOperationId":"patchRefund","summary":"Partially updates a refund with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"schema_412","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The refund was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Refund"}},"schemaId":"components/schemas/Refund","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The refund could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The refund could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve refund based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1refunds~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Refund","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Refund"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/refunds/patchrefund"}],"panels":[]}]},"httpPath":"/refunds/{tenantId}/{id}"},{"label":"Updates a refund with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/refunds/updaterefund","routeSlug":"/apis/collect/collect-v1/refunds/updaterefund","metadata":{"seo":{"title":"Updates a refund with the specified ID.","description":"This method will update an existing refund with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateRefund","name":"Updates a refund with the specified ID.","isWebhook":false,"pointer":"/paths/~1refunds~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a refund with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing refund with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the refund to update.","required":true}],"pointer":"/paths/~1refunds~1{tenantId}~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/Refund"}},"schemaId":"components/schemas/Refund","pointer":"/paths/~1refunds~1{tenantId}~1{id}/put/requestBody","description":"The updated refund that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/refunds/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Refund"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/refunds/{tenantId}/{id}","href":"refunds/updaterefund","openApiOperationId":"updateRefund","summary":"Updates a refund with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Refund","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Refund"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The refund was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Refund"}},"schemaId":"components/schemas/Refund","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The refund supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The refund could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The refund could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve refund based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1refunds~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Refund","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Refund"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/refunds/updaterefund"}],"panels":[]}]},"httpPath":"/refunds/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Refunds"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Refunds","showPageActions":true},{"nodeType":"markdoc","content":"Refunds"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/refunds/defaultTemplate/refund","summary":"Returns the default refund template","prefix":{"name":"get","color":"get"},"badges":[],"link":"/refunds/getdefaultrefundtemplate","deprecated":false},{"title":"/refunds/warmUpStepFunctions","summary":"Initiates workflow to warm up inventory transactions","prefix":{"name":"post","color":"post"},"badges":[],"link":"/refunds/warmupstepfunctions","deprecated":false},{"title":"/refunds/{tenantId}","summary":"Gets all of the refunds in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/refunds/listrefunds","deprecated":false},{"title":"/refunds/{tenantId}","summary":"Creates a new refund that doesn't already exist","prefix":{"name":"post","color":"post"},"badges":[],"link":"/refunds/processrefund","deprecated":false},{"title":"/refunds/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/refunds/executebatchoperations","deprecated":false},{"title":"/refunds/{tenantId}/batch/{batch_id}","summary":"Returns a list of records with the specified batch_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/refunds/listrefundsbybatchid","deprecated":false},{"title":"/refunds/{tenantId}/previewTemplate","summary":"Sends out a preview of the notification template","prefix":{"name":"post","color":"post"},"badges":[],"link":"/refunds/previewtemplate","deprecated":false},{"title":"/refunds/{tenantId}/print/{id}","summary":"Generates a PDF and returns the public link for download","prefix":{"name":"get","color":"get"},"badges":[],"link":"/refunds/downloadpdf","deprecated":false},{"title":"/refunds/{tenantId}/search","summary":"Searches for refunds using predefined parameters","prefix":{"name":"post","color":"post"},"badges":[],"link":"/refunds/searchforrefunds","deprecated":false},{"title":"/refunds/{tenantId}/sync","summary":"Creates a new refund that doesn't already exist","prefix":{"name":"post","color":"post"},"badges":[],"link":"/refunds/processrefundsync","deprecated":false},{"title":"/refunds/{tenantId}/{id}","summary":"Returns a refund from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/refunds/getrefund","deprecated":false},{"title":"/refunds/{tenantId}/{id}","summary":"Partially updates a refund with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/refunds/patchrefund","deprecated":false},{"title":"/refunds/{tenantId}/{id}","summary":"Updates a refund with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/refunds/updaterefund","deprecated":false}]}]}]}]}},{"type":"group","label":"Revenue Recognition Schedules","link":"/apis/collect/collect-v1/revenue-recognition-schedules","routeSlug":"/apis/collect/collect-v1/revenue-recognition-schedules","items":[{"label":"Gets all of the revenue recognition schedules in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/revenue-recognition-schedules/listrevenuerecognitionschedules","routeSlug":"/apis/collect/collect-v1/revenue-recognition-schedules/listrevenuerecognitionschedules","metadata":{"seo":{"title":"Gets all of the revenue recognition schedules in the system.","description":"This method will scan all revenue recognition schedules and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listRevenueRecognitionSchedules","name":"Gets all of the revenue recognition schedules in the system.","isWebhook":false,"pointer":"/paths/~1revenueRecognitionSchedules~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the revenue recognition schedules in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all revenue recognition schedules and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1revenueRecognitionSchedules~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1revenueRecognitionSchedules~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/revenueRecognitionSchedules/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/revenueRecognitionSchedules/{tenantId}","href":"revenue-recognition-schedules/listrevenuerecognitionschedules","openApiOperationId":"listRevenueRecognitionSchedules","summary":"Gets all of the revenue recognition schedules in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The revenue recognition scheduleswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_456"}},"schemaId":"schema_456","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1revenueRecognitionSchedules~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_456","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_456"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/revenue-recognition-schedules/listrevenuerecognitionschedules"}],"panels":[]}]},"httpPath":"/revenueRecognitionSchedules/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/revenue-recognition-schedules/executebatchoperations","routeSlug":"/apis/collect/collect-v1/revenue-recognition-schedules/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1revenueRecognitionSchedules~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1revenueRecognitionSchedules~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1revenueRecognitionSchedules~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/revenueRecognitionSchedules/{tenantId}/batch","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/revenueRecognitionSchedules/{tenantId}/batch","href":"revenue-recognition-schedules/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The revenue recognition schedule could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve revenue recognition schedule based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1revenueRecognitionSchedules~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/revenue-recognition-schedules/executebatchoperations"}],"panels":[]}]},"httpPath":"/revenueRecognitionSchedules/{tenantId}/batch"},{"label":"Returns a list of records with the specified batch_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/revenue-recognition-schedules/listschedulesbybatchid","routeSlug":"/apis/collect/collect-v1/revenue-recognition-schedules/listschedulesbybatchid","metadata":{"seo":{"title":"Returns a list of records with the specified batch_id","description":"Returns a list of records with the specified batch_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listSchedulesByBatchId","name":"Returns a list of records with the specified batch_id","isWebhook":false,"pointer":"/paths/~1revenueRecognitionSchedules~1{tenantId}~1batch~1{batch_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified batch_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":"Returns a list of records with the specified batch_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The tenant","required":true},{"name":"batch_id","in":"path","schemaId":"schema_409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The batch_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1revenueRecognitionSchedules~1{tenantId}~1batch~1{batch_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1revenueRecognitionSchedules~1{tenantId}~1batch~1{batch_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/revenueRecognitionSchedules/{tenantId}/batch/{batch_id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"batch_id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/revenueRecognitionSchedules/{tenantId}/batch/{batch_id}","href":"revenue-recognition-schedules/listschedulesbybatchid","openApiOperationId":"listSchedulesByBatchId","summary":"Returns a list of records with the specified batch_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListRevenueRecognitionSchedulesResponse"}},"schemaId":"components/schemas/ListRevenueRecognitionSchedulesResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1revenueRecognitionSchedules~1{tenantId}~1batch~1{batch_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListRevenueRecognitionSchedulesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListRevenueRecognitionSchedulesResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/revenue-recognition-schedules/listschedulesbybatchid"}],"panels":[]}]},"httpPath":"/revenueRecognitionSchedules/{tenantId}/batch/{batch_id}"},{"label":"Returns a list of OPEN records with the specified business_unit_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/revenue-recognition-schedules/listopenschedulesbybusinessunitid","routeSlug":"/apis/collect/collect-v1/revenue-recognition-schedules/listopenschedulesbybusinessunitid","metadata":{"seo":{"title":"Returns a list of OPEN records with the specified business_unit_id","description":"Returns a list of OPEN records with the specified business_unit_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listOpenSchedulesByBusinessUnitId","name":"Returns a list of OPEN records with the specified business_unit_id","isWebhook":false,"pointer":"/paths/~1revenueRecognitionSchedules~1{tenantId}~1businessUnit~1{business_unit_id}~1open/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of OPEN records with the specified business_unit_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":"Returns a list of OPEN records with the specified business_unit_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The tenant","required":true},{"name":"business_unit_id","in":"path","schemaId":"schema_409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The business_unit_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1revenueRecognitionSchedules~1{tenantId}~1businessUnit~1{business_unit_id}~1open/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1revenueRecognitionSchedules~1{tenantId}~1businessUnit~1{business_unit_id}~1open/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/revenueRecognitionSchedules/{tenantId}/businessUnit/{business_unit_id}/open","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"business_unit_id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/revenueRecognitionSchedules/{tenantId}/businessUnit/{business_unit_id}/open","href":"revenue-recognition-schedules/listopenschedulesbybusinessunitid","openApiOperationId":"listOpenSchedulesByBusinessUnitId","summary":"Returns a list of OPEN records with the specified business_unit_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListRevenueRecognitionSchedulesResponse"}},"schemaId":"components/schemas/ListRevenueRecognitionSchedulesResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1revenueRecognitionSchedules~1{tenantId}~1businessUnit~1{business_unit_id}~1open/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListRevenueRecognitionSchedulesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListRevenueRecognitionSchedulesResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/revenue-recognition-schedules/listopenschedulesbybusinessunitid"}],"panels":[]}]},"httpPath":"/revenueRecognitionSchedules/{tenantId}/businessUnit/{business_unit_id}/open"},{"label":"Returns a list of records with the specified credit_memo_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/revenue-recognition-schedules/listschedulesbycreditmemoid","routeSlug":"/apis/collect/collect-v1/revenue-recognition-schedules/listschedulesbycreditmemoid","metadata":{"seo":{"title":"Returns a list of records with the specified credit_memo_id","description":"Returns a list of records with the specified credit_memo_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listSchedulesByCreditMemoId","name":"Returns a list of records with the specified credit_memo_id","isWebhook":false,"pointer":"/paths/~1revenueRecognitionSchedules~1{tenantId}~1creditMemo~1{credit_memo_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified credit_memo_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":"Returns a list of records with the specified credit_memo_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The tenant","required":true},{"name":"credit_memo_id","in":"path","schemaId":"schema_409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The credit_memo_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1revenueRecognitionSchedules~1{tenantId}~1creditMemo~1{credit_memo_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1revenueRecognitionSchedules~1{tenantId}~1creditMemo~1{credit_memo_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/revenueRecognitionSchedules/{tenantId}/creditMemo/{credit_memo_id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"credit_memo_id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/revenueRecognitionSchedules/{tenantId}/creditMemo/{credit_memo_id}","href":"revenue-recognition-schedules/listschedulesbycreditmemoid","openApiOperationId":"listSchedulesByCreditMemoId","summary":"Returns a list of records with the specified credit_memo_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListRevenueRecognitionSchedulesResponse"}},"schemaId":"components/schemas/ListRevenueRecognitionSchedulesResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1revenueRecognitionSchedules~1{tenantId}~1creditMemo~1{credit_memo_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListRevenueRecognitionSchedulesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListRevenueRecognitionSchedulesResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/revenue-recognition-schedules/listschedulesbycreditmemoid"}],"panels":[]}]},"httpPath":"/revenueRecognitionSchedules/{tenantId}/creditMemo/{credit_memo_id}"},{"label":"Returns a list of records with the specified debit_memo_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/revenue-recognition-schedules/listschedulesbydebitmemoid","routeSlug":"/apis/collect/collect-v1/revenue-recognition-schedules/listschedulesbydebitmemoid","metadata":{"seo":{"title":"Returns a list of records with the specified debit_memo_id","description":"Returns a list of records with the specified debit_memo_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listSchedulesByDebitMemoId","name":"Returns a list of records with the specified debit_memo_id","isWebhook":false,"pointer":"/paths/~1revenueRecognitionSchedules~1{tenantId}~1debitMemo~1{debit_memo_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified debit_memo_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":"Returns a list of records with the specified debit_memo_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The tenant","required":true},{"name":"debit_memo_id","in":"path","schemaId":"schema_409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The debit_memo_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1revenueRecognitionSchedules~1{tenantId}~1debitMemo~1{debit_memo_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1revenueRecognitionSchedules~1{tenantId}~1debitMemo~1{debit_memo_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/revenueRecognitionSchedules/{tenantId}/debitMemo/{debit_memo_id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"debit_memo_id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/revenueRecognitionSchedules/{tenantId}/debitMemo/{debit_memo_id}","href":"revenue-recognition-schedules/listschedulesbydebitmemoid","openApiOperationId":"listSchedulesByDebitMemoId","summary":"Returns a list of records with the specified debit_memo_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListRevenueRecognitionSchedulesResponse"}},"schemaId":"components/schemas/ListRevenueRecognitionSchedulesResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1revenueRecognitionSchedules~1{tenantId}~1debitMemo~1{debit_memo_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListRevenueRecognitionSchedulesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListRevenueRecognitionSchedulesResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/revenue-recognition-schedules/listschedulesbydebitmemoid"}],"panels":[]}]},"httpPath":"/revenueRecognitionSchedules/{tenantId}/debitMemo/{debit_memo_id}"},{"label":"Returns a list of records with the specified invoice_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/revenue-recognition-schedules/listschedulesbyinvoiceid","routeSlug":"/apis/collect/collect-v1/revenue-recognition-schedules/listschedulesbyinvoiceid","metadata":{"seo":{"title":"Returns a list of records with the specified invoice_id","description":"Returns a list of records with the specified invoice_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listSchedulesByInvoiceId","name":"Returns a list of records with the specified invoice_id","isWebhook":false,"pointer":"/paths/~1revenueRecognitionSchedules~1{tenantId}~1invoice~1{invoice_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified invoice_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":"Returns a list of records with the specified invoice_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The tenant","required":true},{"name":"invoice_id","in":"path","schemaId":"schema_409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The invoice_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1revenueRecognitionSchedules~1{tenantId}~1invoice~1{invoice_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1revenueRecognitionSchedules~1{tenantId}~1invoice~1{invoice_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/revenueRecognitionSchedules/{tenantId}/invoice/{invoice_id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"invoice_id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/revenueRecognitionSchedules/{tenantId}/invoice/{invoice_id}","href":"revenue-recognition-schedules/listschedulesbyinvoiceid","openApiOperationId":"listSchedulesByInvoiceId","summary":"Returns a list of records with the specified invoice_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListRevenueRecognitionSchedulesResponse"}},"schemaId":"components/schemas/ListRevenueRecognitionSchedulesResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1revenueRecognitionSchedules~1{tenantId}~1invoice~1{invoice_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListRevenueRecognitionSchedulesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListRevenueRecognitionSchedulesResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/revenue-recognition-schedules/listschedulesbyinvoiceid"}],"panels":[]}]},"httpPath":"/revenueRecognitionSchedules/{tenantId}/invoice/{invoice_id}"},{"label":"Returns a list of records with the specified membership_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/revenue-recognition-schedules/listschedulesbymembershipid","routeSlug":"/apis/collect/collect-v1/revenue-recognition-schedules/listschedulesbymembershipid","metadata":{"seo":{"title":"Returns a list of records with the specified membership_id","description":"Returns a list of records with the specified membership_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listSchedulesByMembershipId","name":"Returns a list of records with the specified membership_id","isWebhook":false,"pointer":"/paths/~1revenueRecognitionSchedules~1{tenantId}~1membership~1{membership_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified membership_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":"Returns a list of records with the specified membership_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The tenant","required":true},{"name":"membership_id","in":"path","schemaId":"schema_409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The membership_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1revenueRecognitionSchedules~1{tenantId}~1membership~1{membership_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1revenueRecognitionSchedules~1{tenantId}~1membership~1{membership_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/revenueRecognitionSchedules/{tenantId}/membership/{membership_id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"membership_id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/revenueRecognitionSchedules/{tenantId}/membership/{membership_id}","href":"revenue-recognition-schedules/listschedulesbymembershipid","openApiOperationId":"listSchedulesByMembershipId","summary":"Returns a list of records with the specified membership_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListRevenueRecognitionSchedulesResponse"}},"schemaId":"components/schemas/ListRevenueRecognitionSchedulesResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1revenueRecognitionSchedules~1{tenantId}~1membership~1{membership_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListRevenueRecognitionSchedulesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListRevenueRecognitionSchedulesResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/revenue-recognition-schedules/listschedulesbymembershipid"}],"panels":[]}]},"httpPath":"/revenueRecognitionSchedules/{tenantId}/membership/{membership_id}"},{"label":"Returns a list of records with the specified payment_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/revenue-recognition-schedules/listschedulesbypaymentid","routeSlug":"/apis/collect/collect-v1/revenue-recognition-schedules/listschedulesbypaymentid","metadata":{"seo":{"title":"Returns a list of records with the specified payment_id","description":"Returns a list of records with the specified payment_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listSchedulesByPaymentId","name":"Returns a list of records with the specified payment_id","isWebhook":false,"pointer":"/paths/~1revenueRecognitionSchedules~1{tenantId}~1payment~1{payment_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified payment_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":"Returns a list of records with the specified payment_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The tenant","required":true},{"name":"payment_id","in":"path","schemaId":"schema_409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The payment_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1revenueRecognitionSchedules~1{tenantId}~1payment~1{payment_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1revenueRecognitionSchedules~1{tenantId}~1payment~1{payment_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/revenueRecognitionSchedules/{tenantId}/payment/{payment_id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"payment_id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/revenueRecognitionSchedules/{tenantId}/payment/{payment_id}","href":"revenue-recognition-schedules/listschedulesbypaymentid","openApiOperationId":"listSchedulesByPaymentId","summary":"Returns a list of records with the specified payment_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListRevenueRecognitionSchedulesResponse"}},"schemaId":"components/schemas/ListRevenueRecognitionSchedulesResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1revenueRecognitionSchedules~1{tenantId}~1payment~1{payment_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListRevenueRecognitionSchedulesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListRevenueRecognitionSchedulesResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/revenue-recognition-schedules/listschedulesbypaymentid"}],"panels":[]}]},"httpPath":"/revenueRecognitionSchedules/{tenantId}/payment/{payment_id}"},{"label":"Returns a list of records with the specified write_off_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/revenue-recognition-schedules/listschedulesbywriteoffid","routeSlug":"/apis/collect/collect-v1/revenue-recognition-schedules/listschedulesbywriteoffid","metadata":{"seo":{"title":"Returns a list of records with the specified write_off_id","description":"Returns a list of records with the specified write_off_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listSchedulesByWriteOffId","name":"Returns a list of records with the specified write_off_id","isWebhook":false,"pointer":"/paths/~1revenueRecognitionSchedules~1{tenantId}~1writeOff~1{write_off_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified write_off_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":"Returns a list of records with the specified write_off_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The tenant","required":true},{"name":"write_off_id","in":"path","schemaId":"schema_409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The write_off_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1revenueRecognitionSchedules~1{tenantId}~1writeOff~1{write_off_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1revenueRecognitionSchedules~1{tenantId}~1writeOff~1{write_off_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/revenueRecognitionSchedules/{tenantId}/writeOff/{write_off_id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"write_off_id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/revenueRecognitionSchedules/{tenantId}/writeOff/{write_off_id}","href":"revenue-recognition-schedules/listschedulesbywriteoffid","openApiOperationId":"listSchedulesByWriteOffId","summary":"Returns a list of records with the specified write_off_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListRevenueRecognitionSchedulesResponse"}},"schemaId":"components/schemas/ListRevenueRecognitionSchedulesResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1revenueRecognitionSchedules~1{tenantId}~1writeOff~1{write_off_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListRevenueRecognitionSchedulesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListRevenueRecognitionSchedulesResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/revenue-recognition-schedules/listschedulesbywriteoffid"}],"panels":[]}]},"httpPath":"/revenueRecognitionSchedules/{tenantId}/writeOff/{write_off_id}"},{"label":"Returns a revenue recognition schedule from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/revenue-recognition-schedules/getrevenuerecognitionschedule","routeSlug":"/apis/collect/collect-v1/revenue-recognition-schedules/getrevenuerecognitionschedule","metadata":{"seo":{"title":"Returns a revenue recognition schedule from the system by its ID.","description":"This method will look up a revenue recognition schedule by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getRevenueRecognitionSchedule","name":"Returns a revenue recognition schedule from the system by its ID.","isWebhook":false,"pointer":"/paths/~1revenueRecognitionSchedules~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a revenue recognition schedule from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a revenue recognition schedule by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the revenue recognition schedule to return.","required":true}],"pointer":"/paths/~1revenueRecognitionSchedules~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_409","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1revenueRecognitionSchedules~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/revenueRecognitionSchedules/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/revenueRecognitionSchedules/{tenantId}/{id}","href":"revenue-recognition-schedules/getrevenuerecognitionschedule","openApiOperationId":"getRevenueRecognitionSchedule","summary":"Returns a revenue recognition schedule from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The revenue recognition schedule was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RevenueRecognitionSchedule"}},"schemaId":"components/schemas/RevenueRecognitionSchedule","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The revenue recognition schedule could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve revenue recognition schedule based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1revenueRecognitionSchedules~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RevenueRecognitionSchedule","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RevenueRecognitionSchedule"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/revenue-recognition-schedules/getrevenuerecognitionschedule"}],"panels":[]}]},"httpPath":"/revenueRecognitionSchedules/{tenantId}/{id}"},{"label":"Partially updates a revenue recognition schedule with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/revenue-recognition-schedules/patchrevenuerecognitionschedule","routeSlug":"/apis/collect/collect-v1/revenue-recognition-schedules/patchrevenuerecognitionschedule","metadata":{"seo":{"title":"Partially updates a revenue recognition schedule with the specified ID.","description":"This method will patch an existing revenue recognition schedule with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchRevenueRecognitionSchedule","name":"Partially updates a revenue recognition schedule with the specified ID.","isWebhook":false,"pointer":"/paths/~1revenueRecognitionSchedules~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a revenue recognition schedule with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing revenue recognition schedule with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the revenue recognition schedule to patch.","required":true}],"pointer":"/paths/~1revenueRecognitionSchedules~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"schemaId":"schema_412","pointer":"/paths/~1revenueRecognitionSchedules~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/revenueRecognitionSchedules/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_412"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/revenueRecognitionSchedules/{tenantId}/{id}","href":"revenue-recognition-schedules/patchrevenuerecognitionschedule","openApiOperationId":"patchRevenueRecognitionSchedule","summary":"Partially updates a revenue recognition schedule with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"schema_412","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The revenue recognition schedule was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RevenueRecognitionSchedule"}},"schemaId":"components/schemas/RevenueRecognitionSchedule","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The revenue recognition schedule could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The revenue recognition schedule could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve revenue recognition schedule based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1revenueRecognitionSchedules~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RevenueRecognitionSchedule","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RevenueRecognitionSchedule"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/revenue-recognition-schedules/patchrevenuerecognitionschedule"}],"panels":[]}]},"httpPath":"/revenueRecognitionSchedules/{tenantId}/{id}"},{"label":"Updates a revenue recognition schedule with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/revenue-recognition-schedules/updaterevenuerecognitionschedule","routeSlug":"/apis/collect/collect-v1/revenue-recognition-schedules/updaterevenuerecognitionschedule","metadata":{"seo":{"title":"Updates a revenue recognition schedule with the specified ID.","description":"This method will update an existing revenue recognition schedule with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateRevenueRecognitionSchedule","name":"Updates a revenue recognition schedule with the specified ID.","isWebhook":false,"pointer":"/paths/~1revenueRecognitionSchedules~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a revenue recognition schedule with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing revenue recognition schedule with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the revenue recognition schedule to update.","required":true}],"pointer":"/paths/~1revenueRecognitionSchedules~1{tenantId}~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/RevenueRecognitionSchedule"}},"schemaId":"components/schemas/RevenueRecognitionSchedule","pointer":"/paths/~1revenueRecognitionSchedules~1{tenantId}~1{id}/put/requestBody","description":"The updated revenue recognition schedule that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/revenueRecognitionSchedules/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RevenueRecognitionSchedule"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/revenueRecognitionSchedules/{tenantId}/{id}","href":"revenue-recognition-schedules/updaterevenuerecognitionschedule","openApiOperationId":"updateRevenueRecognitionSchedule","summary":"Updates a revenue recognition schedule with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/RevenueRecognitionSchedule","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RevenueRecognitionSchedule"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The revenue recognition schedule was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RevenueRecognitionSchedule"}},"schemaId":"components/schemas/RevenueRecognitionSchedule","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The revenue recognition schedule supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The revenue recognition schedule could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The revenue recognition schedule could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve revenue recognition schedule based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1revenueRecognitionSchedules~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RevenueRecognitionSchedule","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RevenueRecognitionSchedule"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/revenue-recognition-schedules/updaterevenuerecognitionschedule"}],"panels":[]}]},"httpPath":"/revenueRecognitionSchedules/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Revenue Recognition Schedules"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Revenue Recognition Schedules","showPageActions":true},{"nodeType":"markdoc","content":"Revenue Recognition Schedules"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/revenueRecognitionSchedules/{tenantId}","summary":"Gets all of the revenue recognition schedules in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/revenue-recognition-schedules/listrevenuerecognitionschedules","deprecated":false},{"title":"/revenueRecognitionSchedules/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/revenue-recognition-schedules/executebatchoperations","deprecated":false},{"title":"/revenueRecognitionSchedules/{tenantId}/batch/{batch_id}","summary":"Returns a list of records with the specified batch_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/revenue-recognition-schedules/listschedulesbybatchid","deprecated":false},{"title":"/revenueRecognitionSchedules/{tenantId}/businessUnit/{business_unit_id}/open","summary":"Returns a list of OPEN records with the specified business_unit_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/revenue-recognition-schedules/listopenschedulesbybusinessunitid","deprecated":false},{"title":"/revenueRecognitionSchedules/{tenantId}/creditMemo/{credit_memo_id}","summary":"Returns a list of records with the specified credit_memo_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/revenue-recognition-schedules/listschedulesbycreditmemoid","deprecated":false},{"title":"/revenueRecognitionSchedules/{tenantId}/debitMemo/{debit_memo_id}","summary":"Returns a list of records with the specified debit_memo_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/revenue-recognition-schedules/listschedulesbydebitmemoid","deprecated":false},{"title":"/revenueRecognitionSchedules/{tenantId}/invoice/{invoice_id}","summary":"Returns a list of records with the specified invoice_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/revenue-recognition-schedules/listschedulesbyinvoiceid","deprecated":false},{"title":"/revenueRecognitionSchedules/{tenantId}/membership/{membership_id}","summary":"Returns a list of records with the specified membership_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/revenue-recognition-schedules/listschedulesbymembershipid","deprecated":false},{"title":"/revenueRecognitionSchedules/{tenantId}/payment/{payment_id}","summary":"Returns a list of records with the specified payment_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/revenue-recognition-schedules/listschedulesbypaymentid","deprecated":false},{"title":"/revenueRecognitionSchedules/{tenantId}/writeOff/{write_off_id}","summary":"Returns a list of records with the specified write_off_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/revenue-recognition-schedules/listschedulesbywriteoffid","deprecated":false},{"title":"/revenueRecognitionSchedules/{tenantId}/{id}","summary":"Returns a revenue recognition schedule from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/revenue-recognition-schedules/getrevenuerecognitionschedule","deprecated":false},{"title":"/revenueRecognitionSchedules/{tenantId}/{id}","summary":"Partially updates a revenue recognition schedule with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/revenue-recognition-schedules/patchrevenuerecognitionschedule","deprecated":false},{"title":"/revenueRecognitionSchedules/{tenantId}/{id}","summary":"Updates a revenue recognition schedule with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/revenue-recognition-schedules/updaterevenuerecognitionschedule","deprecated":false}]}]}]}]}},{"type":"group","label":"Settings","link":"/apis/collect/collect-v1/settings","routeSlug":"/apis/collect/collect-v1/settings","items":[{"label":"Returns a setting from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/settings/deletesetting","routeSlug":"/apis/collect/collect-v1/settings/deletesetting","metadata":{"seo":{"title":"Returns a setting from the system by its ID.","description":"This method will delete a setting with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteSetting","name":"Returns a setting from the system by its ID.","isWebhook":false,"pointer":"/paths/~1settings~1{tenantId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a setting from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a setting with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1settings~1{tenantId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/settings/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/settings/{tenantId}","href":"settings/deletesetting","openApiOperationId":"deleteSetting","summary":"Returns a setting from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The setting was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}},"schemaId":"schema_409","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The setting could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The setting could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to delete setting based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1settings~1{tenantId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_409","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/settings/deletesetting"}],"panels":[]}]},"httpPath":"/settings/{tenantId}"},{"label":"Returns a setting from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/settings/getsetting","routeSlug":"/apis/collect/collect-v1/settings/getsetting","metadata":{"seo":{"title":"Returns a setting from the system by its ID.","description":"This method will look up a setting by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSetting","name":"Returns a setting from the system by its ID.","isWebhook":false,"pointer":"/paths/~1settings~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a setting from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a setting by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1settings~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_409","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1settings~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/settings/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/settings/{tenantId}","href":"settings/getsetting","openApiOperationId":"getSetting","summary":"Returns a setting from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The setting was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Setting"}},"schemaId":"components/schemas/Setting","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The setting could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve setting based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1settings~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Setting","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Setting"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/settings/getsetting"}],"panels":[]}]},"httpPath":"/settings/{tenantId}"},{"label":"Partially updates a setting with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/settings/patchsetting","routeSlug":"/apis/collect/collect-v1/settings/patchsetting","metadata":{"seo":{"title":"Partially updates a setting with the specified ID.","description":"This method will patch an existing setting with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchSetting","name":"Partially updates a setting with the specified ID.","isWebhook":false,"pointer":"/paths/~1settings~1{tenantId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a setting with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing setting with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1settings~1{tenantId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"schemaId":"schema_412","pointer":"/paths/~1settings~1{tenantId}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/settings/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_412"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/settings/{tenantId}","href":"settings/patchsetting","openApiOperationId":"patchSetting","summary":"Partially updates a setting with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"schema_412","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The setting was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Setting"}},"schemaId":"components/schemas/Setting","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The setting could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The setting could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve setting based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1settings~1{tenantId}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Setting","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Setting"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/settings/patchsetting"}],"panels":[]}]},"httpPath":"/settings/{tenantId}"},{"label":"Creates a new setting record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/settings/createsetting","routeSlug":"/apis/collect/collect-v1/settings/createsetting","metadata":{"seo":{"title":"Creates a new setting record that does not already exist.","description":"This method will auto-generate an ID and create a new setting. If an ID is specified for the setting, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createSetting","name":"Creates a new setting record that does not already exist.","isWebhook":false,"pointer":"/paths/~1settings~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new setting record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new setting. If an ID is specified for the setting, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1settings~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Setting"}},"schemaId":"components/schemas/Setting","pointer":"/paths/~1settings~1{tenantId}/post/requestBody","description":"The setting that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/settings/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Setting"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/settings/{tenantId}","href":"settings/createsetting","openApiOperationId":"createSetting","summary":"Creates a new setting record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Setting","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Setting"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The setting was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Setting"}},"schemaId":"components/schemas/Setting","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The setting you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The setting could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add setting based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1settings~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Setting","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Setting"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/settings/createsetting"}],"panels":[]}]},"httpPath":"/settings/{tenantId}"},{"label":"Updates a setting with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/settings/updatesetting","routeSlug":"/apis/collect/collect-v1/settings/updatesetting","metadata":{"seo":{"title":"Updates a setting with the specified ID.","description":"This method will update an existing setting with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateSetting","name":"Updates a setting with the specified ID.","isWebhook":false,"pointer":"/paths/~1settings~1{tenantId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a setting with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing setting with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1settings~1{tenantId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Setting"}},"schemaId":"components/schemas/Setting","pointer":"/paths/~1settings~1{tenantId}/put/requestBody","description":"The updated setting that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/settings/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Setting"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/settings/{tenantId}","href":"settings/updatesetting","openApiOperationId":"updateSetting","summary":"Updates a setting with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Setting","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Setting"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The setting was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Setting"}},"schemaId":"components/schemas/Setting","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The setting supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The setting could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The setting could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve setting based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1settings~1{tenantId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Setting","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Setting"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/settings/updatesetting"}],"panels":[]}]},"httpPath":"/settings/{tenantId}"},{"label":"Get public settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/settings/getpublicsettings","routeSlug":"/apis/collect/collect-v1/settings/getpublicsettings","metadata":{"seo":{"title":"Get public settings","description":"For a given contact, finds the Stripe customer. If none exists, one is created."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPublicSettings","name":"Get public settings","isWebhook":false,"pointer":"/paths/~1settings~1{tenantId}~1public~1settings/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get public settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"For a given contact, finds the Stripe customer. If none exists, one is created."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1settings~1{tenantId}~1public~1settings/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/settings/{tenantId}/public/settings","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/settings/{tenantId}/public/settings","href":"settings/getpublicsettings","openApiOperationId":"getPublicSettings","summary":"Get public settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The customer","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Setting"}},"schemaId":"components/schemas/Setting","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The members supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The members could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Request limit exceeded... please try your request again in a few seconds","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1settings~1{tenantId}~1public~1settings/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Setting","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Setting"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/settings/getpublicsettings"}],"panels":[]}]},"httpPath":"/settings/{tenantId}/public/settings"}],"content":{"contentType":"group","meta":{"name":"Settings"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Settings","showPageActions":true},{"nodeType":"markdoc","content":"Settings"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/settings/{tenantId}","summary":"Returns a setting from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/settings/deletesetting","deprecated":false},{"title":"/settings/{tenantId}","summary":"Returns a setting from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/settings/getsetting","deprecated":false},{"title":"/settings/{tenantId}","summary":"Partially updates a setting with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/settings/patchsetting","deprecated":false},{"title":"/settings/{tenantId}","summary":"Creates a new setting record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/settings/createsetting","deprecated":false},{"title":"/settings/{tenantId}","summary":"Updates a setting with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/settings/updatesetting","deprecated":false},{"title":"/settings/{tenantId}/public/settings","summary":"Get public settings","prefix":{"name":"get","color":"get"},"badges":[],"link":"/settings/getpublicsettings","deprecated":false}]}]}]}]}},{"type":"group","label":"Statement Templates","link":"/apis/collect/collect-v1/statement-templates","routeSlug":"/apis/collect/collect-v1/statement-templates","items":[{"label":"Gets all of the statement templates in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/statement-templates/liststatementtemplates","routeSlug":"/apis/collect/collect-v1/statement-templates/liststatementtemplates","metadata":{"seo":{"title":"Gets all of the statement templates in the system.","description":"This method will scan all statement templates and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listStatementTemplates","name":"Gets all of the statement templates in the system.","isWebhook":false,"pointer":"/paths/~1statementTemplates~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the statement templates in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all statement templates and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1statementTemplates~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1statementTemplates~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/statementTemplates/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/statementTemplates/{tenantId}","href":"statement-templates/liststatementtemplates","openApiOperationId":"listStatementTemplates","summary":"Gets all of the statement templates in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The statement templateswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_457"}},"schemaId":"schema_457","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1statementTemplates~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_457","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_457"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/statement-templates/liststatementtemplates"}],"panels":[]}]},"httpPath":"/statementTemplates/{tenantId}"},{"label":"Creates a new statement template record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/statement-templates/createstatementtemplate","routeSlug":"/apis/collect/collect-v1/statement-templates/createstatementtemplate","metadata":{"seo":{"title":"Creates a new statement template record that does not already exist.","description":"This method will auto-generate an ID and create a new statement template. If an ID is specified for the statement template, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createStatementTemplate","name":"Creates a new statement template record that does not already exist.","isWebhook":false,"pointer":"/paths/~1statementTemplates~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new statement template record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new statement template. If an ID is specified for the statement template, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1statementTemplates~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/StatementTemplate"}},"schemaId":"components/schemas/StatementTemplate","pointer":"/paths/~1statementTemplates~1{tenantId}/post/requestBody","description":"The statement template that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/statementTemplates/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/StatementTemplate"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/statementTemplates/{tenantId}","href":"statement-templates/createstatementtemplate","openApiOperationId":"createStatementTemplate","summary":"Creates a new statement template record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/StatementTemplate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/StatementTemplate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The statement template was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StatementTemplate"}},"schemaId":"components/schemas/StatementTemplate","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The statement template you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The statement template could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add statement template based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1statementTemplates~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/StatementTemplate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StatementTemplate"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/statement-templates/createstatementtemplate"}],"panels":[]}]},"httpPath":"/statementTemplates/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/statement-templates/executebatchoperations","routeSlug":"/apis/collect/collect-v1/statement-templates/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1statementTemplates~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1statementTemplates~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1statementTemplates~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/statementTemplates/{tenantId}/batch","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/statementTemplates/{tenantId}/batch","href":"statement-templates/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The statement template could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve statement template based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1statementTemplates~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/statement-templates/executebatchoperations"}],"panels":[]}]},"httpPath":"/statementTemplates/{tenantId}/batch"},{"label":"Returns a statement template from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/statement-templates/deletestatementtemplate","routeSlug":"/apis/collect/collect-v1/statement-templates/deletestatementtemplate","metadata":{"seo":{"title":"Returns a statement template from the system by its ID.","description":"This method will delete a statement template with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteStatementTemplate","name":"Returns a statement template from the system by its ID.","isWebhook":false,"pointer":"/paths/~1statementTemplates~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a statement template from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a statement template with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the statement template to delete.","required":true}],"pointer":"/paths/~1statementTemplates~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/statementTemplates/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/statementTemplates/{tenantId}/{id}","href":"statement-templates/deletestatementtemplate","openApiOperationId":"deleteStatementTemplate","summary":"Returns a statement template from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The statement template was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}},"schemaId":"schema_409","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The statement template could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The statement template could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to delete statement template based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1statementTemplates~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_409","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/statement-templates/deletestatementtemplate"}],"panels":[]}]},"httpPath":"/statementTemplates/{tenantId}/{id}"},{"label":"Returns a statement template from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/statement-templates/getstatementtemplate","routeSlug":"/apis/collect/collect-v1/statement-templates/getstatementtemplate","metadata":{"seo":{"title":"Returns a statement template from the system by its ID.","description":"This method will look up a statement template by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getStatementTemplate","name":"Returns a statement template from the system by its ID.","isWebhook":false,"pointer":"/paths/~1statementTemplates~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a statement template from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a statement template by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the statement template to return.","required":true}],"pointer":"/paths/~1statementTemplates~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_409","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1statementTemplates~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/statementTemplates/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/statementTemplates/{tenantId}/{id}","href":"statement-templates/getstatementtemplate","openApiOperationId":"getStatementTemplate","summary":"Returns a statement template from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The statement template was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StatementTemplate"}},"schemaId":"components/schemas/StatementTemplate","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The statement template could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve statement template based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1statementTemplates~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/StatementTemplate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StatementTemplate"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/statement-templates/getstatementtemplate"}],"panels":[]}]},"httpPath":"/statementTemplates/{tenantId}/{id}"},{"label":"Partially updates a statement template with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/statement-templates/patchstatementtemplate","routeSlug":"/apis/collect/collect-v1/statement-templates/patchstatementtemplate","metadata":{"seo":{"title":"Partially updates a statement template with the specified ID.","description":"This method will patch an existing statement template with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchStatementTemplate","name":"Partially updates a statement template with the specified ID.","isWebhook":false,"pointer":"/paths/~1statementTemplates~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a statement template with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing statement template with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the statement template to patch.","required":true}],"pointer":"/paths/~1statementTemplates~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"schemaId":"schema_412","pointer":"/paths/~1statementTemplates~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/statementTemplates/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_412"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/statementTemplates/{tenantId}/{id}","href":"statement-templates/patchstatementtemplate","openApiOperationId":"patchStatementTemplate","summary":"Partially updates a statement template with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"schema_412","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The statement template was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StatementTemplate"}},"schemaId":"components/schemas/StatementTemplate","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The statement template could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The statement template could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve statement template based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1statementTemplates~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/StatementTemplate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StatementTemplate"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/statement-templates/patchstatementtemplate"}],"panels":[]}]},"httpPath":"/statementTemplates/{tenantId}/{id}"},{"label":"Updates a statement template with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/statement-templates/updatestatementtemplate","routeSlug":"/apis/collect/collect-v1/statement-templates/updatestatementtemplate","metadata":{"seo":{"title":"Updates a statement template with the specified ID.","description":"This method will update an existing statement template with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateStatementTemplate","name":"Updates a statement template with the specified ID.","isWebhook":false,"pointer":"/paths/~1statementTemplates~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a statement template with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing statement template with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the statement template to update.","required":true}],"pointer":"/paths/~1statementTemplates~1{tenantId}~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/StatementTemplate"}},"schemaId":"components/schemas/StatementTemplate","pointer":"/paths/~1statementTemplates~1{tenantId}~1{id}/put/requestBody","description":"The updated statement template that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/statementTemplates/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/StatementTemplate"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/statementTemplates/{tenantId}/{id}","href":"statement-templates/updatestatementtemplate","openApiOperationId":"updateStatementTemplate","summary":"Updates a statement template with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/StatementTemplate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/StatementTemplate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The statement template was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StatementTemplate"}},"schemaId":"components/schemas/StatementTemplate","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The statement template supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The statement template could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The statement template could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve statement template based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1statementTemplates~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/StatementTemplate","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StatementTemplate"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/statement-templates/updatestatementtemplate"}],"panels":[]}]},"httpPath":"/statementTemplates/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Statement Templates"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Statement Templates","showPageActions":true},{"nodeType":"markdoc","content":"Statement Templates"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/statementTemplates/{tenantId}","summary":"Gets all of the statement templates in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/statement-templates/liststatementtemplates","deprecated":false},{"title":"/statementTemplates/{tenantId}","summary":"Creates a new statement template record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/statement-templates/createstatementtemplate","deprecated":false},{"title":"/statementTemplates/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/statement-templates/executebatchoperations","deprecated":false},{"title":"/statementTemplates/{tenantId}/{id}","summary":"Returns a statement template from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/statement-templates/deletestatementtemplate","deprecated":false},{"title":"/statementTemplates/{tenantId}/{id}","summary":"Returns a statement template from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/statement-templates/getstatementtemplate","deprecated":false},{"title":"/statementTemplates/{tenantId}/{id}","summary":"Partially updates a statement template with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/statement-templates/patchstatementtemplate","deprecated":false},{"title":"/statementTemplates/{tenantId}/{id}","summary":"Updates a statement template with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/statement-templates/updatestatementtemplate","deprecated":false}]}]}]}]}},{"type":"group","label":"Statements","link":"/apis/collect/collect-v1/statements","routeSlug":"/apis/collect/collect-v1/statements","items":[{"label":"Creates a new statement record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/statements/createstatement","routeSlug":"/apis/collect/collect-v1/statements/createstatement","metadata":{"seo":{"title":"Creates a new statement record that does not already exist.","description":"This method will auto-generate an ID and create a new statement. If an ID is specified for the statement, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createStatement","name":"Creates a new statement record that does not already exist.","isWebhook":false,"pointer":"/paths/~1statements~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new statement record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new statement. If an ID is specified for the statement, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1statements~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Statement"}},"schemaId":"components/schemas/Statement","pointer":"/paths/~1statements~1{tenantId}/post/requestBody","description":"The statement that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/statements/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Statement"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/statements/{tenantId}","href":"statements/createstatement","openApiOperationId":"createStatement","summary":"Creates a new statement record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Statement","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Statement"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The statement was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Statement"}},"schemaId":"components/schemas/Statement","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The statement you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The statement could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add statement based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1statements~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Statement","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Statement"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/statements/createstatement"}],"panels":[]}]},"httpPath":"/statements/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/statements/executebatchoperations","routeSlug":"/apis/collect/collect-v1/statements/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1statements~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1statements~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1statements~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/statements/{tenantId}/batch","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/statements/{tenantId}/batch","href":"statements/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The statement could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve statement based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1statements~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/statements/executebatchoperations"}],"panels":[]}]},"httpPath":"/statements/{tenantId}/batch"},{"label":"Returns a list of records with the specified contact_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/statements/liststatementsbycontactid","routeSlug":"/apis/collect/collect-v1/statements/liststatementsbycontactid","metadata":{"seo":{"title":"Returns a list of records with the specified contact_id","description":"Returns a list of records with the specified contact_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listStatementsByContactId","name":"Returns a list of records with the specified contact_id","isWebhook":false,"pointer":"/paths/~1statements~1{tenantId}~1contact~1{contact_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified contact_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":"Returns a list of records with the specified contact_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The tenant","required":true},{"name":"contact_id","in":"path","schemaId":"schema_409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contact_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1statements~1{tenantId}~1contact~1{contact_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1statements~1{tenantId}~1contact~1{contact_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/statements/{tenantId}/contact/{contact_id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"contact_id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/statements/{tenantId}/contact/{contact_id}","href":"statements/liststatementsbycontactid","openApiOperationId":"listStatementsByContactId","summary":"Returns a list of records with the specified contact_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListStatementsResponse"}},"schemaId":"components/schemas/ListStatementsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1statements~1{tenantId}~1contact~1{contact_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListStatementsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListStatementsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/statements/liststatementsbycontactid"}],"panels":[]}]},"httpPath":"/statements/{tenantId}/contact/{contact_id}"},{"label":"Returns the default customer balance statement template","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/statements/getdefaultcustomerbalancestatementtemplate","routeSlug":"/apis/collect/collect-v1/statements/getdefaultcustomerbalancestatementtemplate","metadata":{"seo":{"title":"Returns the default customer balance statement template","description":"Returns the default customer balance statement template"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDefaultCustomerBalanceStatementTemplate","name":"Returns the default customer balance statement template","isWebhook":false,"pointer":"/paths/~1statements~1{tenantId}~1defaultStatementTemplate/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns the default customer balance statement template","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the default customer balance statement template"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The tenant","required":true}],"pointer":"/paths/~1statements~1{tenantId}~1defaultStatementTemplate/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/statements/{tenantId}/defaultStatementTemplate","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/statements/{tenantId}/defaultStatementTemplate","href":"statements/getdefaultcustomerbalancestatementtemplate","openApiOperationId":"getDefaultCustomerBalanceStatementTemplate","summary":"Returns the default customer balance statement template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The template","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EmailTemplateSchema"}},"schemaId":"components/schemas/EmailTemplateSchema","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The invoice could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve invoice based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1statements~1{tenantId}~1defaultStatementTemplate/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/EmailTemplateSchema","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EmailTemplateSchema"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/statements/getdefaultcustomerbalancestatementtemplate"}],"panels":[]}]},"httpPath":"/statements/{tenantId}/defaultStatementTemplate"},{"label":"Generate/Send Customer Statement","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/statements/generatecustomerbalancestatement","routeSlug":"/apis/collect/collect-v1/statements/generatecustomerbalancestatement","metadata":{"seo":{"title":"Generate/Send Customer Statement","description":"Generates and optionally sends a customer statement"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"generateCustomerBalanceStatement","name":"Generate/Send Customer Statement","isWebhook":false,"pointer":"/paths/~1statements~1{tenantId}~1generate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Generate/Send Customer Statement","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Generates and optionally sends a customer statement"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed","required":true}],"pointer":"/paths/~1statements~1{tenantId}~1generate/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/StatementGenerationRequest"}},"schemaId":"components/schemas/StatementGenerationRequest","pointer":"/paths/~1statements~1{tenantId}~1generate/post/requestBody","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The domain_name to use to for record lookup"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/statements/{tenantId}/generate","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/StatementGenerationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/statements/{tenantId}/generate","href":"statements/generatecustomerbalancestatement","openApiOperationId":"generateCustomerBalanceStatement","summary":"Generate/Send Customer Statement"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/StatementGenerationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/StatementGenerationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The invoice was downloaded successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}},"schemaId":"schema_409","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The invoice could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve invoice based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1statements~1{tenantId}~1generate/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_409","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/statements/generatecustomerbalancestatement"}],"panels":[]}]},"httpPath":"/statements/{tenantId}/generate"},{"label":"Returns a list of records with the specified organization_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/statements/liststatementsbyorganizationid","routeSlug":"/apis/collect/collect-v1/statements/liststatementsbyorganizationid","metadata":{"seo":{"title":"Returns a list of records with the specified organization_id","description":"Returns a list of records with the specified organization_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listStatementsByOrganizationId","name":"Returns a list of records with the specified organization_id","isWebhook":false,"pointer":"/paths/~1statements~1{tenantId}~1organization~1{organization_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified organization_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":"Returns a list of records with the specified organization_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The tenant","required":true},{"name":"organization_id","in":"path","schemaId":"schema_409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The organization_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1statements~1{tenantId}~1organization~1{organization_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1statements~1{tenantId}~1organization~1{organization_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/statements/{tenantId}/organization/{organization_id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"organization_id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/statements/{tenantId}/organization/{organization_id}","href":"statements/liststatementsbyorganizationid","openApiOperationId":"listStatementsByOrganizationId","summary":"Returns a list of records with the specified organization_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListStatementsResponse"}},"schemaId":"components/schemas/ListStatementsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1statements~1{tenantId}~1organization~1{organization_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListStatementsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListStatementsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/statements/liststatementsbyorganizationid"}],"panels":[]}]},"httpPath":"/statements/{tenantId}/organization/{organization_id}"},{"label":"Sends out a preview of the notification email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/statements/previewemail","routeSlug":"/apis/collect/collect-v1/statements/previewemail","metadata":{"seo":{"title":"Sends out a preview of the notification email","description":"Sends out a preview of the notification email"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"previewEmail","name":"Sends out a preview of the notification email","isWebhook":false,"pointer":"/paths/~1statements~1{tenantId}~1previewEmail/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sends out a preview of the notification email","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Sends out a preview of the notification email"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The tenant","required":true}],"pointer":"/paths/~1statements~1{tenantId}~1previewEmail/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PreviewEmailRequest"}},"schemaId":"components/schemas/PreviewEmailRequest","pointer":"/paths/~1statements~1{tenantId}~1previewEmail/post/requestBody","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The domain_name to use to for record lookup"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/statements/{tenantId}/previewEmail","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PreviewEmailRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/statements/{tenantId}/previewEmail","href":"statements/previewemail","openApiOperationId":"previewEmail","summary":"Sends out a preview of the notification email"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/PreviewEmailRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PreviewEmailRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The record was retrieved successfully","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"Unable to locate any organizations with the specified domain","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1statements~1{tenantId}~1previewEmail/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/statements/previewemail"}],"panels":[]}]},"httpPath":"/statements/{tenantId}/previewEmail"},{"label":"Sends out a preview of the notification template","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/statements/previewtemplate","routeSlug":"/apis/collect/collect-v1/statements/previewtemplate","metadata":{"seo":{"title":"Sends out a preview of the notification template","description":"Sends out a preview of the notification template"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"previewTemplate","name":"Sends out a preview of the notification template","isWebhook":false,"pointer":"/paths/~1statements~1{tenantId}~1previewTemplate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Sends out a preview of the notification template","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Sends out a preview of the notification template"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The tenant","required":true}],"pointer":"/paths/~1statements~1{tenantId}~1previewTemplate/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PreviewTemplateRequest"}},"schemaId":"components/schemas/PreviewTemplateRequest","pointer":"/paths/~1statements~1{tenantId}~1previewTemplate/post/requestBody","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The domain_name to use to for record lookup"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/statements/{tenantId}/previewTemplate","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PreviewTemplateRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/statements/{tenantId}/previewTemplate","href":"statements/previewtemplate","openApiOperationId":"previewTemplate","summary":"Sends out a preview of the notification template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/PreviewTemplateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PreviewTemplateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The record was retrieved successfully","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"Unable to locate any organizations with the specified domain","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1statements~1{tenantId}~1previewTemplate/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/statements/previewtemplate"}],"panels":[]}]},"httpPath":"/statements/{tenantId}/previewTemplate"},{"label":"Returns a statement from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/statements/deletestatement","routeSlug":"/apis/collect/collect-v1/statements/deletestatement","metadata":{"seo":{"title":"Returns a statement from the system by its ID.","description":"This method will delete a statement with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteStatement","name":"Returns a statement from the system by its ID.","isWebhook":false,"pointer":"/paths/~1statements~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a statement from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a statement with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the statement to delete.","required":true}],"pointer":"/paths/~1statements~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/statements/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/statements/{tenantId}/{id}","href":"statements/deletestatement","openApiOperationId":"deleteStatement","summary":"Returns a statement from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The statement was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}},"schemaId":"schema_409","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The statement could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The statement could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to delete statement based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1statements~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_409","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/statements/deletestatement"}],"panels":[]}]},"httpPath":"/statements/{tenantId}/{id}"},{"label":"Returns a statement from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/statements/getstatement","routeSlug":"/apis/collect/collect-v1/statements/getstatement","metadata":{"seo":{"title":"Returns a statement from the system by its ID.","description":"This method will look up a statement by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getStatement","name":"Returns a statement from the system by its ID.","isWebhook":false,"pointer":"/paths/~1statements~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a statement from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a statement by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the statement to return.","required":true}],"pointer":"/paths/~1statements~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_409","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1statements~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/statements/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/statements/{tenantId}/{id}","href":"statements/getstatement","openApiOperationId":"getStatement","summary":"Returns a statement from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The statement was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Statement"}},"schemaId":"components/schemas/Statement","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The statement could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve statement based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1statements~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Statement","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Statement"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/statements/getstatement"}],"panels":[]}]},"httpPath":"/statements/{tenantId}/{id}"},{"label":"Partially updates a statement with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/statements/patchstatement","routeSlug":"/apis/collect/collect-v1/statements/patchstatement","metadata":{"seo":{"title":"Partially updates a statement with the specified ID.","description":"This method will patch an existing statement with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchStatement","name":"Partially updates a statement with the specified ID.","isWebhook":false,"pointer":"/paths/~1statements~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a statement with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing statement with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the statement to patch.","required":true}],"pointer":"/paths/~1statements~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"schemaId":"schema_412","pointer":"/paths/~1statements~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/statements/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_412"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/statements/{tenantId}/{id}","href":"statements/patchstatement","openApiOperationId":"patchStatement","summary":"Partially updates a statement with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"schema_412","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The statement was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Statement"}},"schemaId":"components/schemas/Statement","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The statement could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The statement could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve statement based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1statements~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Statement","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Statement"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/statements/patchstatement"}],"panels":[]}]},"httpPath":"/statements/{tenantId}/{id}"},{"label":"Updates a statement with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/statements/updatestatement","routeSlug":"/apis/collect/collect-v1/statements/updatestatement","metadata":{"seo":{"title":"Updates a statement with the specified ID.","description":"This method will update an existing statement with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateStatement","name":"Updates a statement with the specified ID.","isWebhook":false,"pointer":"/paths/~1statements~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a statement with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing statement with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the statement to update.","required":true}],"pointer":"/paths/~1statements~1{tenantId}~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/Statement"}},"schemaId":"components/schemas/Statement","pointer":"/paths/~1statements~1{tenantId}~1{id}/put/requestBody","description":"The updated statement that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/statements/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Statement"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/statements/{tenantId}/{id}","href":"statements/updatestatement","openApiOperationId":"updateStatement","summary":"Updates a statement with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/Statement","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Statement"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The statement was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Statement"}},"schemaId":"components/schemas/Statement","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The statement supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The statement could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The statement could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve statement based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1statements~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Statement","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Statement"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/statements/updatestatement"}],"panels":[]}]},"httpPath":"/statements/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Statements"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Statements","showPageActions":true},{"nodeType":"markdoc","content":"Statements"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/statements/{tenantId}","summary":"Creates a new statement record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/statements/createstatement","deprecated":false},{"title":"/statements/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/statements/executebatchoperations","deprecated":false},{"title":"/statements/{tenantId}/contact/{contact_id}","summary":"Returns a list of records with the specified contact_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/statements/liststatementsbycontactid","deprecated":false},{"title":"/statements/{tenantId}/defaultStatementTemplate","summary":"Returns the default customer balance statement template","prefix":{"name":"get","color":"get"},"badges":[],"link":"/statements/getdefaultcustomerbalancestatementtemplate","deprecated":false},{"title":"/statements/{tenantId}/generate","summary":"Generate/Send Customer Statement","prefix":{"name":"post","color":"post"},"badges":[],"link":"/statements/generatecustomerbalancestatement","deprecated":false},{"title":"/statements/{tenantId}/organization/{organization_id}","summary":"Returns a list of records with the specified organization_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/statements/liststatementsbyorganizationid","deprecated":false},{"title":"/statements/{tenantId}/previewEmail","summary":"Sends out a preview of the notification email","prefix":{"name":"post","color":"post"},"badges":[],"link":"/statements/previewemail","deprecated":false},{"title":"/statements/{tenantId}/previewTemplate","summary":"Sends out a preview of the notification template","prefix":{"name":"post","color":"post"},"badges":[],"link":"/statements/previewtemplate","deprecated":false},{"title":"/statements/{tenantId}/{id}","summary":"Returns a statement from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/statements/deletestatement","deprecated":false},{"title":"/statements/{tenantId}/{id}","summary":"Returns a statement from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/statements/getstatement","deprecated":false},{"title":"/statements/{tenantId}/{id}","summary":"Partially updates a statement with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/statements/patchstatement","deprecated":false},{"title":"/statements/{tenantId}/{id}","summary":"Updates a statement with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/statements/updatestatement","deprecated":false}]}]}]}]}},{"type":"group","label":"Statistics","link":"/apis/collect/collect-v1/statistics","routeSlug":"/apis/collect/collect-v1/statistics","items":[{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/statistics/executebatchoperations","routeSlug":"/apis/collect/collect-v1/statistics/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1statistics~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1statistics~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1statistics~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/statistics/{tenantId}/batch","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/statistics/{tenantId}/batch","href":"statistics/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The statistic could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve statistic based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1statistics~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/statistics/executebatchoperations"}],"panels":[]}]},"httpPath":"/statistics/{tenantId}/batch"},{"label":"Returns a statistic from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/statistics/getstatistic","routeSlug":"/apis/collect/collect-v1/statistics/getstatistic","metadata":{"seo":{"title":"Returns a statistic from the system by its ID.","description":"This method will look up a statistic by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getStatistic","name":"Returns a statistic from the system by its ID.","isWebhook":false,"pointer":"/paths/~1statistics~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a statistic from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a statistic by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the statistic to return.","required":true}],"pointer":"/paths/~1statistics~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"parameters","in":"query","schemaId":"schema_409","description":"Parameters to the query"},{"name":"recalculate","in":"query","schemaId":"schema_428","description":"If true, the latest statistic will be calculated and the cache will be updated"}],"pointer":"/paths/~1statistics~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/statistics/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"parameters","in":"query","required":false,"schemaId":"schema_409"},{"name":"recalculate","in":"query","required":false,"schemaId":"schema_428"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/statistics/{tenantId}/{id}","href":"statistics/getstatistic","openApiOperationId":"getStatistic","summary":"Returns a statistic from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The statistic was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Statistic"}},"schemaId":"components/schemas/Statistic","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The statistic could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve statistic based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1statistics~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Statistic","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Statistic"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/statistics/getstatistic"}],"panels":[]}]},"httpPath":"/statistics/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Statistics"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Statistics","showPageActions":true},{"nodeType":"markdoc","content":"Statistics"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/statistics/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/statistics/executebatchoperations","deprecated":false},{"title":"/statistics/{tenantId}/{id}","summary":"Returns a statistic from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/statistics/getstatistic","deprecated":false}]}]}]}]}},{"type":"group","label":"Stored Payment Methods","link":"/apis/collect/collect-v1/stored-payment-methods","routeSlug":"/apis/collect/collect-v1/stored-payment-methods","items":[{"label":"Creates a new stored payment method record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/stored-payment-methods/createstoredpaymentmethod","routeSlug":"/apis/collect/collect-v1/stored-payment-methods/createstoredpaymentmethod","metadata":{"seo":{"title":"Creates a new stored payment method record that does not already exist.","description":"This method will auto-generate an ID and create a new stored payment method. If an ID is specified for the stored payment method, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createStoredPaymentMethod","name":"Creates a new stored payment method record that does not already exist.","isWebhook":false,"pointer":"/paths/~1storedPaymentMethods~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new stored payment method record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new stored payment method. If an ID is specified for the stored payment method, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1storedPaymentMethods~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/StoredPaymentMethod"}},"schemaId":"components/schemas/StoredPaymentMethod","pointer":"/paths/~1storedPaymentMethods~1{tenantId}/post/requestBody","description":"The stored payment method that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/storedPaymentMethods/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/StoredPaymentMethod"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/storedPaymentMethods/{tenantId}","href":"stored-payment-methods/createstoredpaymentmethod","openApiOperationId":"createStoredPaymentMethod","summary":"Creates a new stored payment method record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/StoredPaymentMethod","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/StoredPaymentMethod"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The stored payment method was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StoredPaymentMethod"}},"schemaId":"components/schemas/StoredPaymentMethod","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The stored payment method you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The stored payment method could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add stored payment method based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1storedPaymentMethods~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/StoredPaymentMethod","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StoredPaymentMethod"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/stored-payment-methods/createstoredpaymentmethod"}],"panels":[]}]},"httpPath":"/storedPaymentMethods/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/stored-payment-methods/executebatchoperations","routeSlug":"/apis/collect/collect-v1/stored-payment-methods/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1storedPaymentMethods~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1storedPaymentMethods~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1storedPaymentMethods~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/storedPaymentMethods/{tenantId}/batch","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/storedPaymentMethods/{tenantId}/batch","href":"stored-payment-methods/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The stored payment method could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve stored payment method based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1storedPaymentMethods~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/stored-payment-methods/executebatchoperations"}],"panels":[]}]},"httpPath":"/storedPaymentMethods/{tenantId}/batch"},{"label":"Returns a list of records with the specified contact_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/stored-payment-methods/listmethodsbycontactid","routeSlug":"/apis/collect/collect-v1/stored-payment-methods/listmethodsbycontactid","metadata":{"seo":{"title":"Returns a list of records with the specified contact_id","description":"Returns a list of records with the specified contact_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listMethodsByContactId","name":"Returns a list of records with the specified contact_id","isWebhook":false,"pointer":"/paths/~1storedPaymentMethods~1{tenantId}~1contact~1{contact_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified contact_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":"Returns a list of records with the specified contact_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The tenant","required":true},{"name":"contact_id","in":"path","schemaId":"schema_409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The contact_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1storedPaymentMethods~1{tenantId}~1contact~1{contact_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1storedPaymentMethods~1{tenantId}~1contact~1{contact_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/storedPaymentMethods/{tenantId}/contact/{contact_id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"contact_id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/storedPaymentMethods/{tenantId}/contact/{contact_id}","href":"stored-payment-methods/listmethodsbycontactid","openApiOperationId":"listMethodsByContactId","summary":"Returns a list of records with the specified contact_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListStoredPaymentMethodsResponse"}},"schemaId":"components/schemas/ListStoredPaymentMethodsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1storedPaymentMethods~1{tenantId}~1contact~1{contact_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListStoredPaymentMethodsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListStoredPaymentMethodsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/stored-payment-methods/listmethodsbycontactid"}],"panels":[]}]},"httpPath":"/storedPaymentMethods/{tenantId}/contact/{contact_id}"},{"label":"Gets all of the stored payment methods in the system for a given contact.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/stored-payment-methods/liststoredpaymentmethodsforportal","routeSlug":"/apis/collect/collect-v1/stored-payment-methods/liststoredpaymentmethodsforportal","metadata":{"seo":{"title":"Gets all of the stored payment methods in the system for a given contact.","description":"This method will scan all stored payment methods and and return them to the caller for a given contact."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listStoredPaymentMethodsForPortal","name":"Gets all of the stored payment methods in the system for a given contact.","isWebhook":false,"pointer":"/paths/~1storedPaymentMethods~1{tenantId}~1portal~1contact~1{portalContactId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the stored payment methods in the system for a given contact.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all stored payment methods and and return them to the caller for a given contact."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"portalContactId","in":"path","schemaId":"schema_409","description":"The contact to use","required":true}],"pointer":"/paths/~1storedPaymentMethods~1{tenantId}~1portal~1contact~1{portalContactId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."}],"pointer":"/paths/~1storedPaymentMethods~1{tenantId}~1portal~1contact~1{portalContactId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/storedPaymentMethods/{tenantId}/portal/contact/{portalContactId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"portalContactId","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/storedPaymentMethods/{tenantId}/portal/contact/{portalContactId}","href":"stored-payment-methods/liststoredpaymentmethodsforportal","openApiOperationId":"listStoredPaymentMethodsForPortal","summary":"Gets all of the stored payment methods in the system for a given contact."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The stored payment methodswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListStoredPaymentMethodsResponse"}},"schemaId":"components/schemas/ListStoredPaymentMethodsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1storedPaymentMethods~1{tenantId}~1portal~1contact~1{portalContactId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListStoredPaymentMethodsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListStoredPaymentMethodsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/stored-payment-methods/liststoredpaymentmethodsforportal"}],"panels":[]}]},"httpPath":"/storedPaymentMethods/{tenantId}/portal/contact/{portalContactId}"},{"label":"Creates a new stored payment method record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/stored-payment-methods/createstoredpaymentmethodforportal","routeSlug":"/apis/collect/collect-v1/stored-payment-methods/createstoredpaymentmethodforportal","metadata":{"seo":{"title":"Creates a new stored payment method record that does not already exist.","description":"This method will auto-generate an ID and create a new stored payment method. If an ID is specified for the stored payment method, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createStoredPaymentMethodForPortal","name":"Creates a new stored payment method record that does not already exist.","isWebhook":false,"pointer":"/paths/~1storedPaymentMethods~1{tenantId}~1portal~1contact~1{portalContactId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new stored payment method record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new stored payment method. If an ID is specified for the stored payment method, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"portalContactId","in":"path","schemaId":"schema_409","description":"The contact to use","required":true}],"pointer":"/paths/~1storedPaymentMethods~1{tenantId}~1portal~1contact~1{portalContactId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/StoredPaymentMethod"}},"schemaId":"components/schemas/StoredPaymentMethod","pointer":"/paths/~1storedPaymentMethods~1{tenantId}~1portal~1contact~1{portalContactId}/post/requestBody","description":"The stored payment method that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/storedPaymentMethods/{tenantId}/portal/contact/{portalContactId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"portalContactId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/StoredPaymentMethod"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/storedPaymentMethods/{tenantId}/portal/contact/{portalContactId}","href":"stored-payment-methods/createstoredpaymentmethodforportal","openApiOperationId":"createStoredPaymentMethodForPortal","summary":"Creates a new stored payment method record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/StoredPaymentMethod","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/StoredPaymentMethod"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The stored payment method was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StoredPaymentMethod"}},"schemaId":"components/schemas/StoredPaymentMethod","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The stored payment method you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The stored payment method could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add stored payment method based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1storedPaymentMethods~1{tenantId}~1portal~1contact~1{portalContactId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/StoredPaymentMethod","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StoredPaymentMethod"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/stored-payment-methods/createstoredpaymentmethodforportal"}],"panels":[]}]},"httpPath":"/storedPaymentMethods/{tenantId}/portal/contact/{portalContactId}"},{"label":"Returns a stored payment method from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/stored-payment-methods/deletestoredpaymentmethodforportal","routeSlug":"/apis/collect/collect-v1/stored-payment-methods/deletestoredpaymentmethodforportal","metadata":{"seo":{"title":"Returns a stored payment method from the system by its ID.","description":"This method will delete a stored payment method with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteStoredPaymentMethodForPortal","name":"Returns a stored payment method from the system by its ID.","isWebhook":false,"pointer":"/paths/~1storedPaymentMethods~1{tenantId}~1portal~1contact~1{portalContactId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a stored payment method from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a stored payment method with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"portalContactId","in":"path","schemaId":"schema_409","description":"The contact to use","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the stored payment method to delete.","required":true}],"pointer":"/paths/~1storedPaymentMethods~1{tenantId}~1portal~1contact~1{portalContactId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/storedPaymentMethods/{tenantId}/portal/contact/{portalContactId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"portalContactId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/storedPaymentMethods/{tenantId}/portal/contact/{portalContactId}/{id}","href":"stored-payment-methods/deletestoredpaymentmethodforportal","openApiOperationId":"deleteStoredPaymentMethodForPortal","summary":"Returns a stored payment method from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The stored payment method was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}},"schemaId":"schema_409","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The stored payment method could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The stored payment method could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to delete stored payment method based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1storedPaymentMethods~1{tenantId}~1portal~1contact~1{portalContactId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_409","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/stored-payment-methods/deletestoredpaymentmethodforportal"}],"panels":[]}]},"httpPath":"/storedPaymentMethods/{tenantId}/portal/contact/{portalContactId}/{id}"},{"label":"Returns a stored payment method from the system by its ID for a given contact.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/stored-payment-methods/getstoredpaymentmethodforportal","routeSlug":"/apis/collect/collect-v1/stored-payment-methods/getstoredpaymentmethodforportal","metadata":{"seo":{"title":"Returns a stored payment method from the system by its ID for a given contact.","description":"This method will look up a stored payment method by the specified ID and return it back (for a portal contact)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getStoredPaymentMethodForPortal","name":"Returns a stored payment method from the system by its ID for a given contact.","isWebhook":false,"pointer":"/paths/~1storedPaymentMethods~1{tenantId}~1portal~1contact~1{portalContactId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a stored payment method from the system by its ID for a given contact.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a stored payment method by the specified ID and return it back (for a portal contact)"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"portalContactId","in":"path","schemaId":"schema_409","description":"The contact to use","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the stored payment method to return.","required":true}],"pointer":"/paths/~1storedPaymentMethods~1{tenantId}~1portal~1contact~1{portalContactId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_409","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1storedPaymentMethods~1{tenantId}~1portal~1contact~1{portalContactId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/storedPaymentMethods/{tenantId}/portal/contact/{portalContactId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"portalContactId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/storedPaymentMethods/{tenantId}/portal/contact/{portalContactId}/{id}","href":"stored-payment-methods/getstoredpaymentmethodforportal","openApiOperationId":"getStoredPaymentMethodForPortal","summary":"Returns a stored payment method from the system by its ID for a given contact."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The stored payment method was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StoredPaymentMethod"}},"schemaId":"components/schemas/StoredPaymentMethod","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The stored payment method could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve stored payment method based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1storedPaymentMethods~1{tenantId}~1portal~1contact~1{portalContactId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/StoredPaymentMethod","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StoredPaymentMethod"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/stored-payment-methods/getstoredpaymentmethodforportal"}],"panels":[]}]},"httpPath":"/storedPaymentMethods/{tenantId}/portal/contact/{portalContactId}/{id}"},{"label":"Updates a stored payment method with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/stored-payment-methods/updatestoredpaymentmethodforportal","routeSlug":"/apis/collect/collect-v1/stored-payment-methods/updatestoredpaymentmethodforportal","metadata":{"seo":{"title":"Updates a stored payment method with the specified ID.","description":"This method will update an existing stored payment method with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateStoredPaymentMethodForPortal","name":"Updates a stored payment method with the specified ID.","isWebhook":false,"pointer":"/paths/~1storedPaymentMethods~1{tenantId}~1portal~1contact~1{portalContactId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a stored payment method with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing stored payment method with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"portalContactId","in":"path","schemaId":"schema_409","description":"The contact to use","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the stored payment method to update.","required":true}],"pointer":"/paths/~1storedPaymentMethods~1{tenantId}~1portal~1contact~1{portalContactId}~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/StoredPaymentMethod"}},"schemaId":"components/schemas/StoredPaymentMethod","pointer":"/paths/~1storedPaymentMethods~1{tenantId}~1portal~1contact~1{portalContactId}~1{id}/put/requestBody","description":"The updated stored payment method that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/storedPaymentMethods/{tenantId}/portal/contact/{portalContactId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"portalContactId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/StoredPaymentMethod"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/storedPaymentMethods/{tenantId}/portal/contact/{portalContactId}/{id}","href":"stored-payment-methods/updatestoredpaymentmethodforportal","openApiOperationId":"updateStoredPaymentMethodForPortal","summary":"Updates a stored payment method with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/StoredPaymentMethod","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/StoredPaymentMethod"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The stored payment method was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StoredPaymentMethod"}},"schemaId":"components/schemas/StoredPaymentMethod","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The stored payment method supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The stored payment method could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The stored payment method could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve stored payment method based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1storedPaymentMethods~1{tenantId}~1portal~1contact~1{portalContactId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/StoredPaymentMethod","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StoredPaymentMethod"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/stored-payment-methods/updatestoredpaymentmethodforportal"}],"panels":[]}]},"httpPath":"/storedPaymentMethods/{tenantId}/portal/contact/{portalContactId}/{id}"},{"label":"Returns a stored payment method from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/stored-payment-methods/deletestoredpaymentmethod","routeSlug":"/apis/collect/collect-v1/stored-payment-methods/deletestoredpaymentmethod","metadata":{"seo":{"title":"Returns a stored payment method from the system by its ID.","description":"This method will delete a stored payment method with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteStoredPaymentMethod","name":"Returns a stored payment method from the system by its ID.","isWebhook":false,"pointer":"/paths/~1storedPaymentMethods~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a stored payment method from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a stored payment method with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the stored payment method to delete.","required":true}],"pointer":"/paths/~1storedPaymentMethods~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/storedPaymentMethods/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/storedPaymentMethods/{tenantId}/{id}","href":"stored-payment-methods/deletestoredpaymentmethod","openApiOperationId":"deleteStoredPaymentMethod","summary":"Returns a stored payment method from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The stored payment method was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}},"schemaId":"schema_409","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The stored payment method could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The stored payment method could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to delete stored payment method based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1storedPaymentMethods~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_409","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/stored-payment-methods/deletestoredpaymentmethod"}],"panels":[]}]},"httpPath":"/storedPaymentMethods/{tenantId}/{id}"},{"label":"Returns a stored payment method from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/stored-payment-methods/getstoredpaymentmethod","routeSlug":"/apis/collect/collect-v1/stored-payment-methods/getstoredpaymentmethod","metadata":{"seo":{"title":"Returns a stored payment method from the system by its ID.","description":"This method will look up a stored payment method by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getStoredPaymentMethod","name":"Returns a stored payment method from the system by its ID.","isWebhook":false,"pointer":"/paths/~1storedPaymentMethods~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a stored payment method from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a stored payment method by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the stored payment method to return.","required":true}],"pointer":"/paths/~1storedPaymentMethods~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_409","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1storedPaymentMethods~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/storedPaymentMethods/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/storedPaymentMethods/{tenantId}/{id}","href":"stored-payment-methods/getstoredpaymentmethod","openApiOperationId":"getStoredPaymentMethod","summary":"Returns a stored payment method from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The stored payment method was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StoredPaymentMethod"}},"schemaId":"components/schemas/StoredPaymentMethod","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The stored payment method could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve stored payment method based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1storedPaymentMethods~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/StoredPaymentMethod","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StoredPaymentMethod"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/stored-payment-methods/getstoredpaymentmethod"}],"panels":[]}]},"httpPath":"/storedPaymentMethods/{tenantId}/{id}"},{"label":"Partially updates a stored payment method with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/stored-payment-methods/patchstoredpaymentmethod","routeSlug":"/apis/collect/collect-v1/stored-payment-methods/patchstoredpaymentmethod","metadata":{"seo":{"title":"Partially updates a stored payment method with the specified ID.","description":"This method will patch an existing stored payment method with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchStoredPaymentMethod","name":"Partially updates a stored payment method with the specified ID.","isWebhook":false,"pointer":"/paths/~1storedPaymentMethods~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a stored payment method with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing stored payment method with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the stored payment method to patch.","required":true}],"pointer":"/paths/~1storedPaymentMethods~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"schemaId":"schema_412","pointer":"/paths/~1storedPaymentMethods~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/storedPaymentMethods/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_412"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/storedPaymentMethods/{tenantId}/{id}","href":"stored-payment-methods/patchstoredpaymentmethod","openApiOperationId":"patchStoredPaymentMethod","summary":"Partially updates a stored payment method with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"schema_412","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The stored payment method was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StoredPaymentMethod"}},"schemaId":"components/schemas/StoredPaymentMethod","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The stored payment method could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The stored payment method could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve stored payment method based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1storedPaymentMethods~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/StoredPaymentMethod","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StoredPaymentMethod"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/stored-payment-methods/patchstoredpaymentmethod"}],"panels":[]}]},"httpPath":"/storedPaymentMethods/{tenantId}/{id}"},{"label":"Updates a stored payment method with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/stored-payment-methods/updatestoredpaymentmethod","routeSlug":"/apis/collect/collect-v1/stored-payment-methods/updatestoredpaymentmethod","metadata":{"seo":{"title":"Updates a stored payment method with the specified ID.","description":"This method will update an existing stored payment method with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateStoredPaymentMethod","name":"Updates a stored payment method with the specified ID.","isWebhook":false,"pointer":"/paths/~1storedPaymentMethods~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a stored payment method with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing stored payment method with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the stored payment method to update.","required":true}],"pointer":"/paths/~1storedPaymentMethods~1{tenantId}~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/StoredPaymentMethod"}},"schemaId":"components/schemas/StoredPaymentMethod","pointer":"/paths/~1storedPaymentMethods~1{tenantId}~1{id}/put/requestBody","description":"The updated stored payment method that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/storedPaymentMethods/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/StoredPaymentMethod"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/storedPaymentMethods/{tenantId}/{id}","href":"stored-payment-methods/updatestoredpaymentmethod","openApiOperationId":"updateStoredPaymentMethod","summary":"Updates a stored payment method with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/StoredPaymentMethod","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/StoredPaymentMethod"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The stored payment method was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StoredPaymentMethod"}},"schemaId":"components/schemas/StoredPaymentMethod","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The stored payment method supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The stored payment method could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The stored payment method could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve stored payment method based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1storedPaymentMethods~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/StoredPaymentMethod","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StoredPaymentMethod"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/stored-payment-methods/updatestoredpaymentmethod"}],"panels":[]}]},"httpPath":"/storedPaymentMethods/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Stored Payment Methods"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Stored Payment Methods","showPageActions":true},{"nodeType":"markdoc","content":"Stored Payment Methods"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/storedPaymentMethods/{tenantId}","summary":"Creates a new stored payment method record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/stored-payment-methods/createstoredpaymentmethod","deprecated":false},{"title":"/storedPaymentMethods/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/stored-payment-methods/executebatchoperations","deprecated":false},{"title":"/storedPaymentMethods/{tenantId}/contact/{contact_id}","summary":"Returns a list of records with the specified contact_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/stored-payment-methods/listmethodsbycontactid","deprecated":false},{"title":"/storedPaymentMethods/{tenantId}/portal/contact/{portalContactId}","summary":"Gets all of the stored payment methods in the system for a given contact.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/stored-payment-methods/liststoredpaymentmethodsforportal","deprecated":false},{"title":"/storedPaymentMethods/{tenantId}/portal/contact/{portalContactId}","summary":"Creates a new stored payment method record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/stored-payment-methods/createstoredpaymentmethodforportal","deprecated":false},{"title":"/storedPaymentMethods/{tenantId}/portal/contact/{portalContactId}/{id}","summary":"Returns a stored payment method from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/stored-payment-methods/deletestoredpaymentmethodforportal","deprecated":false},{"title":"/storedPaymentMethods/{tenantId}/portal/contact/{portalContactId}/{id}","summary":"Returns a stored payment method from the system by its ID for a given contact.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/stored-payment-methods/getstoredpaymentmethodforportal","deprecated":false},{"title":"/storedPaymentMethods/{tenantId}/portal/contact/{portalContactId}/{id}","summary":"Updates a stored payment method with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/stored-payment-methods/updatestoredpaymentmethodforportal","deprecated":false},{"title":"/storedPaymentMethods/{tenantId}/{id}","summary":"Returns a stored payment method from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/stored-payment-methods/deletestoredpaymentmethod","deprecated":false},{"title":"/storedPaymentMethods/{tenantId}/{id}","summary":"Returns a stored payment method from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/stored-payment-methods/getstoredpaymentmethod","deprecated":false},{"title":"/storedPaymentMethods/{tenantId}/{id}","summary":"Partially updates a stored payment method with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/stored-payment-methods/patchstoredpaymentmethod","deprecated":false},{"title":"/storedPaymentMethods/{tenantId}/{id}","summary":"Updates a stored payment method with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/stored-payment-methods/updatestoredpaymentmethod","deprecated":false}]}]}]}]}},{"type":"group","label":"Subledger Entries","link":"/apis/collect/collect-v1/subledger-entries","routeSlug":"/apis/collect/collect-v1/subledger-entries","items":[{"label":"Creates a new subledger entry record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/subledger-entries/createsubledgerentry","routeSlug":"/apis/collect/collect-v1/subledger-entries/createsubledgerentry","metadata":{"seo":{"title":"Creates a new subledger entry record that does not already exist.","description":"This method will auto-generate an ID and create a new subledger entry. If an ID is specified for the subledger entry, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createSubledgerEntry","name":"Creates a new subledger entry record that does not already exist.","isWebhook":false,"pointer":"/paths/~1subledgerEntries~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new subledger entry record that does not already exist.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new subledger entry. If an ID is specified for the subledger entry, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1subledgerEntries~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SubledgerEntry"}},"schemaId":"components/schemas/SubledgerEntry","pointer":"/paths/~1subledgerEntries~1{tenantId}/post/requestBody","description":"The subledger entry that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/subledgerEntries/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SubledgerEntry"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/subledgerEntries/{tenantId}","href":"subledger-entries/createsubledgerentry","openApiOperationId":"createSubledgerEntry","summary":"Creates a new subledger entry record that does not already exist."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/SubledgerEntry","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SubledgerEntry"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The subledger entry was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubledgerEntry"}},"schemaId":"components/schemas/SubledgerEntry","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The subledger entry you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The subledger entry could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add subledger entry based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1subledgerEntries~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SubledgerEntry","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubledgerEntry"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subledger-entries/createsubledgerentry"}],"panels":[]}]},"httpPath":"/subledgerEntries/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/subledger-entries/executebatchoperations","routeSlug":"/apis/collect/collect-v1/subledger-entries/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1subledgerEntries~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1subledgerEntries~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1subledgerEntries~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/subledgerEntries/{tenantId}/batch","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/subledgerEntries/{tenantId}/batch","href":"subledger-entries/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The subledger entry could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve subledger entry based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1subledgerEntries~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subledger-entries/executebatchoperations"}],"panels":[]}]},"httpPath":"/subledgerEntries/{tenantId}/batch"},{"label":"Returns a list of records with the specified batch_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/subledger-entries/listentriesbybatchid","routeSlug":"/apis/collect/collect-v1/subledger-entries/listentriesbybatchid","metadata":{"seo":{"title":"Returns a list of records with the specified batch_id","description":"Returns a list of records with the specified batch_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listEntriesByBatchId","name":"Returns a list of records with the specified batch_id","isWebhook":false,"pointer":"/paths/~1subledgerEntries~1{tenantId}~1batch~1{batch_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified batch_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":"Returns a list of records with the specified batch_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The tenant","required":true},{"name":"batch_id","in":"path","schemaId":"schema_409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The batch_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1subledgerEntries~1{tenantId}~1batch~1{batch_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1subledgerEntries~1{tenantId}~1batch~1{batch_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/subledgerEntries/{tenantId}/batch/{batch_id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"batch_id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/subledgerEntries/{tenantId}/batch/{batch_id}","href":"subledger-entries/listentriesbybatchid","openApiOperationId":"listEntriesByBatchId","summary":"Returns a list of records with the specified batch_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListSubledgerEntriesResponse"}},"schemaId":"components/schemas/ListSubledgerEntriesResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1subledgerEntries~1{tenantId}~1batch~1{batch_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListSubledgerEntriesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListSubledgerEntriesResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subledger-entries/listentriesbybatchid"}],"panels":[]}]},"httpPath":"/subledgerEntries/{tenantId}/batch/{batch_id}"},{"label":"Returns a list of records with the specified cogs_entry_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/subledger-entries/listentriesbycogsentryid","routeSlug":"/apis/collect/collect-v1/subledger-entries/listentriesbycogsentryid","metadata":{"seo":{"title":"Returns a list of records with the specified cogs_entry_id","description":"Returns a list of records with the specified cogs_entry_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listEntriesByCogsEntryId","name":"Returns a list of records with the specified cogs_entry_id","isWebhook":false,"pointer":"/paths/~1subledgerEntries~1{tenantId}~1cogsEntry~1{cogs_entry_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified cogs_entry_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":"Returns a list of records with the specified cogs_entry_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The tenant","required":true},{"name":"cogs_entry_id","in":"path","schemaId":"schema_409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The cogs_entry_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1subledgerEntries~1{tenantId}~1cogsEntry~1{cogs_entry_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1subledgerEntries~1{tenantId}~1cogsEntry~1{cogs_entry_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/subledgerEntries/{tenantId}/cogsEntry/{cogs_entry_id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"cogs_entry_id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/subledgerEntries/{tenantId}/cogsEntry/{cogs_entry_id}","href":"subledger-entries/listentriesbycogsentryid","openApiOperationId":"listEntriesByCogsEntryId","summary":"Returns a list of records with the specified cogs_entry_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListSubledgerEntriesResponse"}},"schemaId":"components/schemas/ListSubledgerEntriesResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1subledgerEntries~1{tenantId}~1cogsEntry~1{cogs_entry_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListSubledgerEntriesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListSubledgerEntriesResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subledger-entries/listentriesbycogsentryid"}],"panels":[]}]},"httpPath":"/subledgerEntries/{tenantId}/cogsEntry/{cogs_entry_id}"},{"label":"Returns a list of records with the specified credit_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/subledger-entries/listentriesbycreditid","routeSlug":"/apis/collect/collect-v1/subledger-entries/listentriesbycreditid","metadata":{"seo":{"title":"Returns a list of records with the specified credit_id","description":"Returns a list of records with the specified credit_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listEntriesByCreditId","name":"Returns a list of records with the specified credit_id","isWebhook":false,"pointer":"/paths/~1subledgerEntries~1{tenantId}~1credit~1{credit_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified credit_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":"Returns a list of records with the specified credit_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The tenant","required":true},{"name":"credit_id","in":"path","schemaId":"schema_409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The credit_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1subledgerEntries~1{tenantId}~1credit~1{credit_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1subledgerEntries~1{tenantId}~1credit~1{credit_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/subledgerEntries/{tenantId}/credit/{credit_id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"credit_id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/subledgerEntries/{tenantId}/credit/{credit_id}","href":"subledger-entries/listentriesbycreditid","openApiOperationId":"listEntriesByCreditId","summary":"Returns a list of records with the specified credit_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListSubledgerEntriesResponse"}},"schemaId":"components/schemas/ListSubledgerEntriesResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1subledgerEntries~1{tenantId}~1credit~1{credit_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListSubledgerEntriesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListSubledgerEntriesResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subledger-entries/listentriesbycreditid"}],"panels":[]}]},"httpPath":"/subledgerEntries/{tenantId}/credit/{credit_id}"},{"label":"Returns a list of records with the specified credit_memo_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/subledger-entries/listentriesbycreditmemoid","routeSlug":"/apis/collect/collect-v1/subledger-entries/listentriesbycreditmemoid","metadata":{"seo":{"title":"Returns a list of records with the specified credit_memo_id","description":"Returns a list of records with the specified credit_memo_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listEntriesByCreditMemoId","name":"Returns a list of records with the specified credit_memo_id","isWebhook":false,"pointer":"/paths/~1subledgerEntries~1{tenantId}~1creditMemo~1{credit_memo_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified credit_memo_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":"Returns a list of records with the specified credit_memo_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The tenant","required":true},{"name":"credit_memo_id","in":"path","schemaId":"schema_409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The credit_memo_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1subledgerEntries~1{tenantId}~1creditMemo~1{credit_memo_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1subledgerEntries~1{tenantId}~1creditMemo~1{credit_memo_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/subledgerEntries/{tenantId}/creditMemo/{credit_memo_id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"credit_memo_id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/subledgerEntries/{tenantId}/creditMemo/{credit_memo_id}","href":"subledger-entries/listentriesbycreditmemoid","openApiOperationId":"listEntriesByCreditMemoId","summary":"Returns a list of records with the specified credit_memo_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListSubledgerEntriesResponse"}},"schemaId":"components/schemas/ListSubledgerEntriesResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1subledgerEntries~1{tenantId}~1creditMemo~1{credit_memo_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListSubledgerEntriesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListSubledgerEntriesResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subledger-entries/listentriesbycreditmemoid"}],"panels":[]}]},"httpPath":"/subledgerEntries/{tenantId}/creditMemo/{credit_memo_id}"},{"label":"Returns a list of records with the specified debit_memo_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/subledger-entries/listentriesbydebitmemoid","routeSlug":"/apis/collect/collect-v1/subledger-entries/listentriesbydebitmemoid","metadata":{"seo":{"title":"Returns a list of records with the specified debit_memo_id","description":"Returns a list of records with the specified debit_memo_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listEntriesByDebitMemoId","name":"Returns a list of records with the specified debit_memo_id","isWebhook":false,"pointer":"/paths/~1subledgerEntries~1{tenantId}~1debitMemo~1{debit_memo_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified debit_memo_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":"Returns a list of records with the specified debit_memo_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The tenant","required":true},{"name":"debit_memo_id","in":"path","schemaId":"schema_409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The debit_memo_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1subledgerEntries~1{tenantId}~1debitMemo~1{debit_memo_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1subledgerEntries~1{tenantId}~1debitMemo~1{debit_memo_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/subledgerEntries/{tenantId}/debitMemo/{debit_memo_id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"debit_memo_id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/subledgerEntries/{tenantId}/debitMemo/{debit_memo_id}","href":"subledger-entries/listentriesbydebitmemoid","openApiOperationId":"listEntriesByDebitMemoId","summary":"Returns a list of records with the specified debit_memo_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListSubledgerEntriesResponse"}},"schemaId":"components/schemas/ListSubledgerEntriesResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1subledgerEntries~1{tenantId}~1debitMemo~1{debit_memo_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListSubledgerEntriesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListSubledgerEntriesResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subledger-entries/listentriesbydebitmemoid"}],"panels":[]}]},"httpPath":"/subledgerEntries/{tenantId}/debitMemo/{debit_memo_id}"},{"label":"Returns a list of records with the specified fiscal_period","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/subledger-entries/listentriesbyfiscalperiod","routeSlug":"/apis/collect/collect-v1/subledger-entries/listentriesbyfiscalperiod","metadata":{"seo":{"title":"Returns a list of records with the specified fiscal_period","description":"Returns a list of records with the specified fiscal_period"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listEntriesByFiscalPeriod","name":"Returns a list of records with the specified fiscal_period","isWebhook":false,"pointer":"/paths/~1subledgerEntries~1{tenantId}~1fiscalPeriod~1{business_unit_id}~1{fiscal_year_id}~1{fiscal_period}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified fiscal_period","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 records with the specified fiscal_period"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The tenant","required":true},{"name":"business_unit_id","in":"path","schemaId":"schema_409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The business_unit_id to use to for record lookup"},"children":[]}]}]}],"required":true},{"name":"fiscal_year_id","in":"path","schemaId":"schema_409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The fiscal_year_id to use to for record lookup"},"children":[]}]}]}],"required":true},{"name":"fiscal_period","in":"path","schemaId":"schema_409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The fiscal_period to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1subledgerEntries~1{tenantId}~1fiscalPeriod~1{business_unit_id}~1{fiscal_year_id}~1{fiscal_period}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1subledgerEntries~1{tenantId}~1fiscalPeriod~1{business_unit_id}~1{fiscal_year_id}~1{fiscal_period}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/subledgerEntries/{tenantId}/fiscalPeriod/{business_unit_id}/{fiscal_year_id}/{fiscal_period}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"business_unit_id","in":"path","required":true,"schemaId":"schema_409"},{"name":"fiscal_year_id","in":"path","required":true,"schemaId":"schema_409"},{"name":"fiscal_period","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/subledgerEntries/{tenantId}/fiscalPeriod/{business_unit_id}/{fiscal_year_id}/{fiscal_period}","href":"subledger-entries/listentriesbyfiscalperiod","openApiOperationId":"listEntriesByFiscalPeriod","summary":"Returns a list of records with the specified fiscal_period"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListSubledgerEntriesResponse"}},"schemaId":"components/schemas/ListSubledgerEntriesResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1subledgerEntries~1{tenantId}~1fiscalPeriod~1{business_unit_id}~1{fiscal_year_id}~1{fiscal_period}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListSubledgerEntriesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListSubledgerEntriesResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subledger-entries/listentriesbyfiscalperiod"}],"panels":[]}]},"httpPath":"/subledgerEntries/{tenantId}/fiscalPeriod/{business_unit_id}/{fiscal_year_id}/{fiscal_period}"},{"label":"Returns a list of records with the specified inventory_receipt_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/subledger-entries/listentriesbyinventoryreceiptid","routeSlug":"/apis/collect/collect-v1/subledger-entries/listentriesbyinventoryreceiptid","metadata":{"seo":{"title":"Returns a list of records with the specified inventory_receipt_id","description":"Returns a list of records with the specified inventory_receipt_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listEntriesByInventoryReceiptId","name":"Returns a list of records with the specified inventory_receipt_id","isWebhook":false,"pointer":"/paths/~1subledgerEntries~1{tenantId}~1inventoryReceipt~1{inventory_receipt_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified inventory_receipt_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":"Returns a list of records with the specified inventory_receipt_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The tenant","required":true},{"name":"inventory_receipt_id","in":"path","schemaId":"schema_409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The inventory_receipt_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1subledgerEntries~1{tenantId}~1inventoryReceipt~1{inventory_receipt_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1subledgerEntries~1{tenantId}~1inventoryReceipt~1{inventory_receipt_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/subledgerEntries/{tenantId}/inventoryReceipt/{inventory_receipt_id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"inventory_receipt_id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/subledgerEntries/{tenantId}/inventoryReceipt/{inventory_receipt_id}","href":"subledger-entries/listentriesbyinventoryreceiptid","openApiOperationId":"listEntriesByInventoryReceiptId","summary":"Returns a list of records with the specified inventory_receipt_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListSubledgerEntriesResponse"}},"schemaId":"components/schemas/ListSubledgerEntriesResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1subledgerEntries~1{tenantId}~1inventoryReceipt~1{inventory_receipt_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListSubledgerEntriesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListSubledgerEntriesResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subledger-entries/listentriesbyinventoryreceiptid"}],"panels":[]}]},"httpPath":"/subledgerEntries/{tenantId}/inventoryReceipt/{inventory_receipt_id}"},{"label":"Returns a list of records with the specified invoice_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/subledger-entries/listentriesbyinvoiceid","routeSlug":"/apis/collect/collect-v1/subledger-entries/listentriesbyinvoiceid","metadata":{"seo":{"title":"Returns a list of records with the specified invoice_id","description":"Returns a list of records with the specified invoice_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listEntriesByInvoiceId","name":"Returns a list of records with the specified invoice_id","isWebhook":false,"pointer":"/paths/~1subledgerEntries~1{tenantId}~1invoice~1{invoice_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified invoice_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":"Returns a list of records with the specified invoice_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The tenant","required":true},{"name":"invoice_id","in":"path","schemaId":"schema_409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The invoice_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1subledgerEntries~1{tenantId}~1invoice~1{invoice_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1subledgerEntries~1{tenantId}~1invoice~1{invoice_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/subledgerEntries/{tenantId}/invoice/{invoice_id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"invoice_id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/subledgerEntries/{tenantId}/invoice/{invoice_id}","href":"subledger-entries/listentriesbyinvoiceid","openApiOperationId":"listEntriesByInvoiceId","summary":"Returns a list of records with the specified invoice_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListSubledgerEntriesResponse"}},"schemaId":"components/schemas/ListSubledgerEntriesResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1subledgerEntries~1{tenantId}~1invoice~1{invoice_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListSubledgerEntriesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListSubledgerEntriesResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subledger-entries/listentriesbyinvoiceid"}],"panels":[]}]},"httpPath":"/subledgerEntries/{tenantId}/invoice/{invoice_id}"},{"label":"Returns a list of records with the specified payment_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/subledger-entries/listentriesbypaymentid","routeSlug":"/apis/collect/collect-v1/subledger-entries/listentriesbypaymentid","metadata":{"seo":{"title":"Returns a list of records with the specified payment_id","description":"Returns a list of records with the specified payment_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listEntriesByPaymentId","name":"Returns a list of records with the specified payment_id","isWebhook":false,"pointer":"/paths/~1subledgerEntries~1{tenantId}~1payment~1{payment_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified payment_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":"Returns a list of records with the specified payment_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The tenant","required":true},{"name":"payment_id","in":"path","schemaId":"schema_409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The payment_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1subledgerEntries~1{tenantId}~1payment~1{payment_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1subledgerEntries~1{tenantId}~1payment~1{payment_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/subledgerEntries/{tenantId}/payment/{payment_id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"payment_id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/subledgerEntries/{tenantId}/payment/{payment_id}","href":"subledger-entries/listentriesbypaymentid","openApiOperationId":"listEntriesByPaymentId","summary":"Returns a list of records with the specified payment_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListSubledgerEntriesResponse"}},"schemaId":"components/schemas/ListSubledgerEntriesResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1subledgerEntries~1{tenantId}~1payment~1{payment_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListSubledgerEntriesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListSubledgerEntriesResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subledger-entries/listentriesbypaymentid"}],"panels":[]}]},"httpPath":"/subledgerEntries/{tenantId}/payment/{payment_id}"},{"label":"Returns a list of records with the specified revenue_recognition_schedule_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/subledger-entries/listentriesbyrevenuerecognitionscheduleid","routeSlug":"/apis/collect/collect-v1/subledger-entries/listentriesbyrevenuerecognitionscheduleid","metadata":{"seo":{"title":"Returns a list of records with the specified revenue_recognition_schedule_id","description":"Returns a list of records with the specified revenue_recognition_schedule_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listEntriesByRevenueRecognitionScheduleId","name":"Returns a list of records with the specified revenue_recognition_schedule_id","isWebhook":false,"pointer":"/paths/~1subledgerEntries~1{tenantId}~1revenueRecognitionSchedule~1{revenue_recognition_schedule_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified revenue_recognition_schedule_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":"Returns a list of records with the specified revenue_recognition_schedule_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The tenant","required":true},{"name":"revenue_recognition_schedule_id","in":"path","schemaId":"schema_409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The revenue_recognition_schedule_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1subledgerEntries~1{tenantId}~1revenueRecognitionSchedule~1{revenue_recognition_schedule_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1subledgerEntries~1{tenantId}~1revenueRecognitionSchedule~1{revenue_recognition_schedule_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/subledgerEntries/{tenantId}/revenueRecognitionSchedule/{revenue_recognition_schedule_id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"revenue_recognition_schedule_id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/subledgerEntries/{tenantId}/revenueRecognitionSchedule/{revenue_recognition_schedule_id}","href":"subledger-entries/listentriesbyrevenuerecognitionscheduleid","openApiOperationId":"listEntriesByRevenueRecognitionScheduleId","summary":"Returns a list of records with the specified revenue_recognition_schedule_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListSubledgerEntriesResponse"}},"schemaId":"components/schemas/ListSubledgerEntriesResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1subledgerEntries~1{tenantId}~1revenueRecognitionSchedule~1{revenue_recognition_schedule_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListSubledgerEntriesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListSubledgerEntriesResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subledger-entries/listentriesbyrevenuerecognitionscheduleid"}],"panels":[]}]},"httpPath":"/subledgerEntries/{tenantId}/revenueRecognitionSchedule/{revenue_recognition_schedule_id}"},{"label":"Returns a list of records with the specified write_off_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/subledger-entries/listentriesbywriteoffid","routeSlug":"/apis/collect/collect-v1/subledger-entries/listentriesbywriteoffid","metadata":{"seo":{"title":"Returns a list of records with the specified write_off_id","description":"Returns a list of records with the specified write_off_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listEntriesByWriteOffId","name":"Returns a list of records with the specified write_off_id","isWebhook":false,"pointer":"/paths/~1subledgerEntries~1{tenantId}~1writeOff~1{write_off_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified write_off_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":"Returns a list of records with the specified write_off_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The tenant","required":true},{"name":"write_off_id","in":"path","schemaId":"schema_409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The write_off_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1subledgerEntries~1{tenantId}~1writeOff~1{write_off_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1subledgerEntries~1{tenantId}~1writeOff~1{write_off_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/subledgerEntries/{tenantId}/writeOff/{write_off_id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"write_off_id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/subledgerEntries/{tenantId}/writeOff/{write_off_id}","href":"subledger-entries/listentriesbywriteoffid","openApiOperationId":"listEntriesByWriteOffId","summary":"Returns a list of records with the specified write_off_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListSubledgerEntriesResponse"}},"schemaId":"components/schemas/ListSubledgerEntriesResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1subledgerEntries~1{tenantId}~1writeOff~1{write_off_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListSubledgerEntriesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListSubledgerEntriesResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subledger-entries/listentriesbywriteoffid"}],"panels":[]}]},"httpPath":"/subledgerEntries/{tenantId}/writeOff/{write_off_id}"},{"label":"Returns a subledger entry from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/subledger-entries/deletesubledgerentry","routeSlug":"/apis/collect/collect-v1/subledger-entries/deletesubledgerentry","metadata":{"seo":{"title":"Returns a subledger entry from the system by its ID.","description":"This method will delete a subledger entry with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteSubledgerEntry","name":"Returns a subledger entry from the system by its ID.","isWebhook":false,"pointer":"/paths/~1subledgerEntries~1{tenantId}~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a subledger entry from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will delete a subledger entry with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the subledger entry to delete.","required":true}],"pointer":"/paths/~1subledgerEntries~1{tenantId}~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/subledgerEntries/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/subledgerEntries/{tenantId}/{id}","href":"subledger-entries/deletesubledgerentry","openApiOperationId":"deleteSubledgerEntry","summary":"Returns a subledger entry from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The subledger entry was deleted successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}},"schemaId":"schema_409","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The subledger entry could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The subledger entry could not be deleted because other objects refers to/depends on this one.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to delete subledger entry based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1subledgerEntries~1{tenantId}~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_409","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_409"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subledger-entries/deletesubledgerentry"}],"panels":[]}]},"httpPath":"/subledgerEntries/{tenantId}/{id}"},{"label":"Returns a subledger entry from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/subledger-entries/getsubledgerentry","routeSlug":"/apis/collect/collect-v1/subledger-entries/getsubledgerentry","metadata":{"seo":{"title":"Returns a subledger entry from the system by its ID.","description":"This method will look up a subledger entry by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSubledgerEntry","name":"Returns a subledger entry from the system by its ID.","isWebhook":false,"pointer":"/paths/~1subledgerEntries~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a subledger entry from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a subledger entry by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the subledger entry to return.","required":true}],"pointer":"/paths/~1subledgerEntries~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_409","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1subledgerEntries~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/subledgerEntries/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/subledgerEntries/{tenantId}/{id}","href":"subledger-entries/getsubledgerentry","openApiOperationId":"getSubledgerEntry","summary":"Returns a subledger entry from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The subledger entry was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubledgerEntry"}},"schemaId":"components/schemas/SubledgerEntry","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The subledger entry could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve subledger entry based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1subledgerEntries~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SubledgerEntry","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubledgerEntry"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subledger-entries/getsubledgerentry"}],"panels":[]}]},"httpPath":"/subledgerEntries/{tenantId}/{id}"},{"label":"Partially updates a subledger entry with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/subledger-entries/patchsubledgerentry","routeSlug":"/apis/collect/collect-v1/subledger-entries/patchsubledgerentry","metadata":{"seo":{"title":"Partially updates a subledger entry with the specified ID.","description":"This method will patch an existing subledger entry with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchSubledgerEntry","name":"Partially updates a subledger entry with the specified ID.","isWebhook":false,"pointer":"/paths/~1subledgerEntries~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a subledger entry with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing subledger entry with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the subledger entry to patch.","required":true}],"pointer":"/paths/~1subledgerEntries~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"schemaId":"schema_412","pointer":"/paths/~1subledgerEntries~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/subledgerEntries/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_412"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/subledgerEntries/{tenantId}/{id}","href":"subledger-entries/patchsubledgerentry","openApiOperationId":"patchSubledgerEntry","summary":"Partially updates a subledger entry with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"schema_412","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The subledger entry was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubledgerEntry"}},"schemaId":"components/schemas/SubledgerEntry","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The subledger entry could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The subledger entry could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve subledger entry based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1subledgerEntries~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SubledgerEntry","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubledgerEntry"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subledger-entries/patchsubledgerentry"}],"panels":[]}]},"httpPath":"/subledgerEntries/{tenantId}/{id}"},{"label":"Updates a subledger entry with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/subledger-entries/updatesubledgerentry","routeSlug":"/apis/collect/collect-v1/subledger-entries/updatesubledgerentry","metadata":{"seo":{"title":"Updates a subledger entry with the specified ID.","description":"This method will update an existing subledger entry with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateSubledgerEntry","name":"Updates a subledger entry with the specified ID.","isWebhook":false,"pointer":"/paths/~1subledgerEntries~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a subledger entry with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing subledger entry with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the subledger entry to update.","required":true}],"pointer":"/paths/~1subledgerEntries~1{tenantId}~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/SubledgerEntry"}},"schemaId":"components/schemas/SubledgerEntry","pointer":"/paths/~1subledgerEntries~1{tenantId}~1{id}/put/requestBody","description":"The updated subledger entry that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/subledgerEntries/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SubledgerEntry"}},"responseCodes":["200","400","401","403","404","405","409","429","500"],"pointer":"/subledgerEntries/{tenantId}/{id}","href":"subledger-entries/updatesubledgerentry","openApiOperationId":"updateSubledgerEntry","summary":"Updates a subledger entry with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/SubledgerEntry","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SubledgerEntry"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The subledger entry was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubledgerEntry"}},"schemaId":"components/schemas/SubledgerEntry","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The subledger entry supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The subledger entry could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"405","description":"The request method is not allowed.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The subledger entry could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve subledger entry based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1subledgerEntries~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SubledgerEntry","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubledgerEntry"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"405"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/subledger-entries/updatesubledgerentry"}],"panels":[]}]},"httpPath":"/subledgerEntries/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Subledger Entries"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Subledger Entries","showPageActions":true},{"nodeType":"markdoc","content":"Subledger Entries"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/subledgerEntries/{tenantId}","summary":"Creates a new subledger entry record that does not already exist.","prefix":{"name":"post","color":"post"},"badges":[],"link":"/subledger-entries/createsubledgerentry","deprecated":false},{"title":"/subledgerEntries/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/subledger-entries/executebatchoperations","deprecated":false},{"title":"/subledgerEntries/{tenantId}/batch/{batch_id}","summary":"Returns a list of records with the specified batch_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subledger-entries/listentriesbybatchid","deprecated":false},{"title":"/subledgerEntries/{tenantId}/cogsEntry/{cogs_entry_id}","summary":"Returns a list of records with the specified cogs_entry_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subledger-entries/listentriesbycogsentryid","deprecated":false},{"title":"/subledgerEntries/{tenantId}/credit/{credit_id}","summary":"Returns a list of records with the specified credit_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subledger-entries/listentriesbycreditid","deprecated":false},{"title":"/subledgerEntries/{tenantId}/creditMemo/{credit_memo_id}","summary":"Returns a list of records with the specified credit_memo_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subledger-entries/listentriesbycreditmemoid","deprecated":false},{"title":"/subledgerEntries/{tenantId}/debitMemo/{debit_memo_id}","summary":"Returns a list of records with the specified debit_memo_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subledger-entries/listentriesbydebitmemoid","deprecated":false},{"title":"/subledgerEntries/{tenantId}/fiscalPeriod/{business_unit_id}/{fiscal_year_id}/{fiscal_period}","summary":"Returns a list of records with the specified fiscal_period","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subledger-entries/listentriesbyfiscalperiod","deprecated":false},{"title":"/subledgerEntries/{tenantId}/inventoryReceipt/{inventory_receipt_id}","summary":"Returns a list of records with the specified inventory_receipt_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subledger-entries/listentriesbyinventoryreceiptid","deprecated":false},{"title":"/subledgerEntries/{tenantId}/invoice/{invoice_id}","summary":"Returns a list of records with the specified invoice_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subledger-entries/listentriesbyinvoiceid","deprecated":false},{"title":"/subledgerEntries/{tenantId}/payment/{payment_id}","summary":"Returns a list of records with the specified payment_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subledger-entries/listentriesbypaymentid","deprecated":false},{"title":"/subledgerEntries/{tenantId}/revenueRecognitionSchedule/{revenue_recognition_schedule_id}","summary":"Returns a list of records with the specified revenue_recognition_schedule_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subledger-entries/listentriesbyrevenuerecognitionscheduleid","deprecated":false},{"title":"/subledgerEntries/{tenantId}/writeOff/{write_off_id}","summary":"Returns a list of records with the specified write_off_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subledger-entries/listentriesbywriteoffid","deprecated":false},{"title":"/subledgerEntries/{tenantId}/{id}","summary":"Returns a subledger entry from the system by its ID.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/subledger-entries/deletesubledgerentry","deprecated":false},{"title":"/subledgerEntries/{tenantId}/{id}","summary":"Returns a subledger entry from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/subledger-entries/getsubledgerentry","deprecated":false},{"title":"/subledgerEntries/{tenantId}/{id}","summary":"Partially updates a subledger entry with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/subledger-entries/patchsubledgerentry","deprecated":false},{"title":"/subledgerEntries/{tenantId}/{id}","summary":"Updates a subledger entry with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/subledger-entries/updatesubledgerentry","deprecated":false}]}]}]}]}},{"type":"group","label":"Write Offs","link":"/apis/collect/collect-v1/write-offs","routeSlug":"/apis/collect/collect-v1/write-offs","items":[{"label":"Initiates workflow to warm up inventory transactions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/write-offs/warmupstepfunctions","routeSlug":"/apis/collect/collect-v1/write-offs/warmupstepfunctions","metadata":{"seo":{"title":"Initiates workflow to warm up inventory transactions","description":"Initiates workflow to warm up inventory transactions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"warmUpStepFunctions","name":"Initiates workflow to warm up inventory transactions","isWebhook":false,"pointer":"/paths/~1writeOffs~1warmUpStepFunctions/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Initiates workflow to warm up inventory transactions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/writeOffs/warmUpStepFunctions","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/writeOffs/warmUpStepFunctions","href":"write-offs/warmupstepfunctions","openApiOperationId":"warmUpStepFunctions","summary":"Initiates workflow to warm up inventory transactions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Request limit exceeded... please try your request again in a few seconds","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"An internal server error occured.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1writeOffs~1warmUpStepFunctions/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/write-offs/warmupstepfunctions"}],"panels":[]}]},"httpPath":"/writeOffs/warmUpStepFunctions"},{"label":"Gets all of the write offs in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/write-offs/listwriteoffs","routeSlug":"/apis/collect/collect-v1/write-offs/listwriteoffs","metadata":{"seo":{"title":"Gets all of the write offs in the system.","description":"This method will scan all write offs and and return them to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listWriteOffs","name":"Gets all of the write offs in the system.","isWebhook":false,"pointer":"/paths/~1writeOffs~1{tenantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets all of the write offs in the system.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will scan all write offs and and return them to the caller."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1writeOffs~1{tenantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"The start key, if you're making a subsequent request"}],"pointer":"/paths/~1writeOffs~1{tenantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/writeOffs/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/writeOffs/{tenantId}","href":"write-offs/listwriteoffs","openApiOperationId":"listWriteOffs","summary":"Gets all of the write offs in the system."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The write offswere retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_458"}},"schemaId":"schema_458","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add contact role based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1writeOffs~1{tenantId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_458","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_458"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/write-offs/listwriteoffs"}],"panels":[]}]},"httpPath":"/writeOffs/{tenantId}"},{"label":"Processes a new write off","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/write-offs/processwriteoff","routeSlug":"/apis/collect/collect-v1/write-offs/processwriteoff","metadata":{"seo":{"title":"Processes a new write off","description":"This method will auto-generate an ID and create a new write off. If an ID is specified for the write off, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"processWriteOff","name":"Processes a new write off","isWebhook":false,"pointer":"/paths/~1writeOffs~1{tenantId}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Processes a new write off","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new write off. If an ID is specified for the write off, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1writeOffs~1{tenantId}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WriteOff"}},"schemaId":"components/schemas/WriteOff","pointer":"/paths/~1writeOffs~1{tenantId}/post/requestBody","description":"The write off that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/writeOffs/{tenantId}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/WriteOff"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/writeOffs/{tenantId}","href":"write-offs/processwriteoff","openApiOperationId":"processWriteOff","summary":"Processes a new write off"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/WriteOff","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WriteOff"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The write off was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StepFunctionExecutionToken"}},"schemaId":"components/schemas/StepFunctionExecutionToken","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The write off you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The write off could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add write off based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1writeOffs~1{tenantId}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/StepFunctionExecutionToken","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/StepFunctionExecutionToken"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/write-offs/processwriteoff"}],"panels":[]}]},"httpPath":"/writeOffs/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/write-offs/executebatchoperations","routeSlug":"/apis/collect/collect-v1/write-offs/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeBatchOperations","name":"Execute Batch Operations","isWebhook":false,"pointer":"/paths/~1writeOffs~1{tenantId}~1batch/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute Batch Operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"TAllows you to perform up to 100 parallel patch/delete operations"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1writeOffs~1{tenantId}~1batch/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"schemaId":"components/schemas/BatchOperationRequest","pointer":"/paths/~1writeOffs~1{tenantId}~1batch/post/requestBody","description":"The batch request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/writeOffs/{tenantId}/batch","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/writeOffs/{tenantId}/batch","href":"write-offs/executebatchoperations","openApiOperationId":"executeBatchOperations","summary":"Execute Batch Operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/BatchOperationRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BatchOperationRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Request completed successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}},"schemaId":"components/schemas/BatchOperationResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The write off could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve write off based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1writeOffs~1{tenantId}~1batch/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/BatchOperationResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchOperationResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/write-offs/executebatchoperations"}],"panels":[]}]},"httpPath":"/writeOffs/{tenantId}/batch"},{"label":"Returns a list of records with the specified batch_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/write-offs/listoffsbybatchid","routeSlug":"/apis/collect/collect-v1/write-offs/listoffsbybatchid","metadata":{"seo":{"title":"Returns a list of records with the specified batch_id","description":"Returns a list of records with the specified batch_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listOffsByBatchId","name":"Returns a list of records with the specified batch_id","isWebhook":false,"pointer":"/paths/~1writeOffs~1{tenantId}~1batch~1{batch_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a list of records with the specified batch_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":"Returns a list of records with the specified batch_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The tenant","required":true},{"name":"batch_id","in":"path","schemaId":"schema_409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The batch_id to use to for record lookup"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1writeOffs~1{tenantId}~1batch~1{batch_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned"},{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"If paging, this allows you to return the next set of results"}],"pointer":"/paths/~1writeOffs~1{tenantId}~1batch~1{batch_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/writeOffs/{tenantId}/batch/{batch_id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"batch_id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/writeOffs/{tenantId}/batch/{batch_id}","href":"write-offs/listoffsbybatchid","openApiOperationId":"listOffsByBatchId","summary":"Returns a list of records with the specified batch_id"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The records were retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListWriteOffsResponse"}},"schemaId":"components/schemas/ListWriteOffsResponse","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"Unable to locate records","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve records based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1writeOffs~1{tenantId}~1batch~1{batch_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ListWriteOffsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ListWriteOffsResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/write-offs/listoffsbybatchid"}],"panels":[]}]},"httpPath":"/writeOffs/{tenantId}/batch/{batch_id}"},{"label":"Searches for write offs using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/write-offs/searchforwriteoffs","routeSlug":"/apis/collect/collect-v1/write-offs/searchforwriteoffs","metadata":{"seo":{"title":"Searches for write offs using predefined parameters","description":"Searches for write offs using predefined parameters"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"searchForWriteOffs","name":"Searches for write offs using predefined parameters","isWebhook":false,"pointer":"/paths/~1writeOffs~1{tenantId}~1search/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Searches for write offs using predefined parameters","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Searches for write offs using predefined parameters"},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1writeOffs~1{tenantId}~1search/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"exclusiveStartKey","in":"query","schemaId":"schema_409","description":"The start key for the search, for paging support"},{"name":"fieldsToReturn","in":"query","schemaId":"schema_409","description":"  The fields that you want to retrieve; if omitted, the entire object is returned"}],"pointer":"/paths/~1writeOffs~1{tenantId}~1search/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreditMemoSearchParameters"}},"schemaId":"components/schemas/CreditMemoSearchParameters","pointer":"/paths/~1writeOffs~1{tenantId}~1search/post/requestBody","description":"The write off that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/writeOffs/{tenantId}/search","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"exclusiveStartKey","in":"query","required":false,"schemaId":"schema_409"},{"name":"fieldsToReturn","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreditMemoSearchParameters"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/writeOffs/{tenantId}/search","href":"write-offs/searchforwriteoffs","openApiOperationId":"searchForWriteOffs","summary":"Searches for write offs using predefined parameters"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/CreditMemoSearchParameters","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreditMemoSearchParameters"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The write off search was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedWriteOffSearchResults"}},"schemaId":"components/schemas/PagedWriteOffSearchResults","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The write off you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The write off could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add write off based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1writeOffs~1{tenantId}~1search/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PagedWriteOffSearchResults","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PagedWriteOffSearchResults"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/write-offs/searchforwriteoffs"}],"panels":[]}]},"httpPath":"/writeOffs/{tenantId}/search"},{"label":"Creates a new credit that doesn't already exist","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/write-offs/processwriteoffsync","routeSlug":"/apis/collect/collect-v1/write-offs/processwriteoffsync","metadata":{"seo":{"title":"Creates a new credit that doesn't already exist","description":"This method will auto-generate an ID and create a new write off. If an ID is specified for the write off, an error will be thrown."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"processWriteOffSync","name":"Creates a new credit that doesn't already exist","isWebhook":false,"pointer":"/paths/~1writeOffs~1{tenantId}~1sync/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Creates a new credit that doesn't already exist","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will auto-generate an ID and create a new write off. If an ID is specified for the write off, an error will be thrown."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true}],"pointer":"/paths/~1writeOffs~1{tenantId}~1sync/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WriteOff"}},"schemaId":"components/schemas/WriteOff","pointer":"/paths/~1writeOffs~1{tenantId}~1sync/post/requestBody","description":"The write off that you would like to be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/writeOffs/{tenantId}/sync","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/WriteOff"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/writeOffs/{tenantId}/sync","href":"write-offs/processwriteoffsync","openApiOperationId":"processWriteOffSync","summary":"Creates a new credit that doesn't already exist"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/WriteOff","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WriteOff"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The write off was saved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WriteOff"}},"schemaId":"components/schemas/WriteOff","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The write off you supplied was invalid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The resource could not be found","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The write off could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to add write off based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1writeOffs~1{tenantId}~1sync/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WriteOff","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WriteOff"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/write-offs/processwriteoffsync"}],"panels":[]}]},"httpPath":"/writeOffs/{tenantId}/sync"},{"label":"Returns a write off from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/write-offs/getwriteoff","routeSlug":"/apis/collect/collect-v1/write-offs/getwriteoff","metadata":{"seo":{"title":"Returns a write off from the system by its ID.","description":"This method will look up a write off by the specified ID and return it back."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getWriteOff","name":"Returns a write off from the system by its ID.","isWebhook":false,"pointer":"/paths/~1writeOffs~1{tenantId}~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns a write off from the system by its ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will look up a write off by the specified ID and return it back."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the write off to return.","required":true}],"pointer":"/paths/~1writeOffs~1{tenantId}~1{id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"fields","in":"query","schemaId":"schema_409","description":"The fields that you want to retrieve; if omitted, the entire object is returned."},{"name":"consistentRead","in":"query","schemaId":"schema_409","description":"Indicates the API should force a consistent read on the data source."}],"pointer":"/paths/~1writeOffs~1{tenantId}~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/writeOffs/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[{"name":"fields","in":"query","required":false,"schemaId":"schema_409"},{"name":"consistentRead","in":"query","required":false,"schemaId":"schema_409"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/writeOffs/{tenantId}/{id}","href":"write-offs/getwriteoff","openApiOperationId":"getWriteOff","summary":"Returns a write off from the system by its ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The write off was retrieved successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WriteOff"}},"schemaId":"components/schemas/WriteOff","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The request was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The write off could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve write off based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1writeOffs~1{tenantId}~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WriteOff","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WriteOff"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/write-offs/getwriteoff"}],"panels":[]}]},"httpPath":"/writeOffs/{tenantId}/{id}"},{"label":"Partially updates a write off with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/write-offs/patchwriteoff","routeSlug":"/apis/collect/collect-v1/write-offs/patchwriteoff","metadata":{"seo":{"title":"Partially updates a write off with the specified ID.","description":"This method will patch an existing write off with the specified ID, using the HTTP PATCH specification."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"patchWriteOff","name":"Partially updates a write off with the specified ID.","isWebhook":false,"pointer":"/paths/~1writeOffs~1{tenantId}~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially updates a write off with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will patch an existing write off with the specified ID, using the HTTP PATCH specification."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the write off to patch.","required":true}],"pointer":"/paths/~1writeOffs~1{tenantId}~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"schemaId":"schema_412","pointer":"/paths/~1writeOffs~1{tenantId}~1{id}/patch/requestBody","description":"The patch directives conforming to RFC 6902."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/writeOffs/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_412"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/writeOffs/{tenantId}/{id}","href":"write-offs/patchwriteoff","openApiOperationId":"patchWriteOff","summary":"Partially updates a write off with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"schema_412","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_412"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The write off was patched successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WriteOff"}},"schemaId":"components/schemas/WriteOff","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The JSON patch directive you supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The write off could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The write off could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve write off based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1writeOffs~1{tenantId}~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WriteOff","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WriteOff"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/write-offs/patchwriteoff"}],"panels":[]}]},"httpPath":"/writeOffs/{tenantId}/{id}"},{"label":"Updates a write off with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/write-offs/updatewriteoff","routeSlug":"/apis/collect/collect-v1/write-offs/updatewriteoff","metadata":{"seo":{"title":"Updates a write off with the specified ID.","description":"This method will update an existing write off with the specified ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateWriteOff","name":"Updates a write off with the specified ID.","isWebhook":false,"pointer":"/paths/~1writeOffs~1{tenantId}~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Updates a write off with the specified ID.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This method will update an existing write off with the specified ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"knox-authorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tenantId","in":"path","schemaId":"schema_409","description":"The id of the tenant being accessed.","required":true},{"name":"id","in":"path","schemaId":"schema_409","description":"The ID of the write off to update.","required":true}],"pointer":"/paths/~1writeOffs~1{tenantId}~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/WriteOff"}},"schemaId":"components/schemas/WriteOff","pointer":"/paths/~1writeOffs~1{tenantId}~1{id}/put/requestBody","description":"The updated write off that will be saved."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/writeOffs/{tenantId}/{id}","servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"parameters":{"path":[{"name":"tenantId","in":"path","required":true,"schemaId":"schema_409"},{"name":"id","in":"path","required":true,"schemaId":"schema_409"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/WriteOff"}},"responseCodes":["200","400","401","403","404","409","429","500"],"pointer":"/writeOffs/{tenantId}/{id}","href":"write-offs/updatewriteoff","openApiOperationId":"updateWriteOff","summary":"Updates a write off with the specified ID."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/apis/collect/collect-v1","description":"Mock server","isMockServer":true},{"url":"https://collect.api.rhythmsoftware.com"}],"schemaId":"components/schemas/WriteOff","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WriteOff"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The write off was updated successfully.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WriteOff"}},"schemaId":"components/schemas/WriteOff","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"400","description":"The write off supplied was not valid.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"401","description":"Unauthorized.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"403","description":"Forbidden.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"404","description":"The write off could not be found.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"409","description":"The write off could not be saved because it refers to/depends on a non-existent object.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"429","description":"Limit exceeded... unable to retrieve write off based on tenant limits.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"},{"code":"500","description":"General server error.","headers":{"Access-Control-Allow-Headers":{"schema":{"type":"string"}},"Access-Control-Allow-Methods":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}}},"headerSchemaId":"schema_411"}],"pointer":"/paths/~1writeOffs~1{tenantId}~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/WriteOff","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WriteOff"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409"},{"code":"429"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/write-offs/updatewriteoff"}],"panels":[]}]},"httpPath":"/writeOffs/{tenantId}/{id}"}],"content":{"contentType":"group","meta":{"name":"Write Offs"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Write Offs","showPageActions":true},{"nodeType":"markdoc","content":"Write Offs"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/writeOffs/warmUpStepFunctions","summary":"Initiates workflow to warm up inventory transactions","prefix":{"name":"post","color":"post"},"badges":[],"link":"/write-offs/warmupstepfunctions","deprecated":false},{"title":"/writeOffs/{tenantId}","summary":"Gets all of the write offs in the system.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/write-offs/listwriteoffs","deprecated":false},{"title":"/writeOffs/{tenantId}","summary":"Processes a new write off","prefix":{"name":"post","color":"post"},"badges":[],"link":"/write-offs/processwriteoff","deprecated":false},{"title":"/writeOffs/{tenantId}/batch","summary":"Execute Batch Operations","prefix":{"name":"post","color":"post"},"badges":[],"link":"/write-offs/executebatchoperations","deprecated":false},{"title":"/writeOffs/{tenantId}/batch/{batch_id}","summary":"Returns a list of records with the specified batch_id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/write-offs/listoffsbybatchid","deprecated":false},{"title":"/writeOffs/{tenantId}/search","summary":"Searches for write offs using predefined parameters","prefix":{"name":"post","color":"post"},"badges":[],"link":"/write-offs/searchforwriteoffs","deprecated":false},{"title":"/writeOffs/{tenantId}/sync","summary":"Creates a new credit that doesn't already exist","prefix":{"name":"post","color":"post"},"badges":[],"link":"/write-offs/processwriteoffsync","deprecated":false},{"title":"/writeOffs/{tenantId}/{id}","summary":"Returns a write off from the system by its ID.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/write-offs/getwriteoff","deprecated":false},{"title":"/writeOffs/{tenantId}/{id}","summary":"Partially updates a write off with the specified ID.","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/write-offs/patchwriteoff","deprecated":false},{"title":"/writeOffs/{tenantId}/{id}","summary":"Updates a write off with the specified ID.","prefix":{"name":"put","color":"put"},"badges":[],"link":"/write-offs/updatewriteoff","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/AccountingProject":{"id":"components/schemas/AccountingProject","kind":"json-schema","title":"AccountingProject","data":{"additionalProperties":false,"properties":{"business_unit_id":{"description":"The business unit","title":"Business Unit","type":"string"},"code":{"description":"The code for the project","title":"Code","type":"string"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"description":{"description":"The name of the accounting project","title":"Description","type":"string"},"display_name":{"description":"The name to display","title":"Display Name","type":"string"},"end_date":{"description":"The date after which this project will no longer be used","format":"date","title":"End Date","type":"string"},"id":{"description":"The unique, string identifier of this accounting project","pattern":"^[\\w\\-_\\s,&@\\.\\\\\\/]+$","title":"ID","type":"string"},"is_active":{"description":"Whether or not this is an active project","title":"Is Active","type":"boolean"},"name":{"description":"The name of the project","title":"Name","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"}},"required":["business_unit_id","code","id","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/Address":{"id":"components/schemas/Address","kind":"json-schema","title":"Address","data":{"additionalProperties":false,"description":"A complete address","properties":{"city":{"description":"The city of the address","title":"City","type":"string"},"country":{"description":"The country ISO code","title":"Country","type":"string"},"country_name":{"description":"The full name of hte country","title":"Country Name","type":"string"},"county":{"description":"The county","title":"County","type":"string"},"latitude":{"format":"double","title":"Latitude","type":"number"},"line1":{"description":"The first line of the address","title":"Line 1","type":"string"},"line2":{"description":"The second line of the address","title":"Line 2","type":"string"},"line3":{"description":"The third line of the address","title":"Line 3","type":"string"},"longitude":{"format":"double","title":"Longitude","type":"number"},"postal_code":{"description":"The zip/postal code","title":"Postal Code","type":"string"},"state":{"description":"The state/province of the address","title":"State","type":"string"},"time_zone_id":{"title":"Time Zone","type":"string"}},"type":"object"}},"components/schemas/BankAccount":{"id":"components/schemas/BankAccount","kind":"json-schema","title":"BankAccount","data":{"additionalProperties":false,"properties":{"business_unit_id":{"description":"The business unit this bank account belongs to","title":"Business Unit","type":"string"},"currency_code":{"description":"The currency of this account","maxLength":3,"minLength":3,"title":"Currency Code","type":"string"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"description":{"description":"Notes/description about the account","title":"Description","type":"string"},"gl_account_id":{"description":"The G/L account that represents the asset of this account","title":"Gl Account","type":"string"},"id":{"description":"The unique, string identifier of this bank account","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether or not this is active","title":"Is Active","type":"boolean"},"name":{"description":"The name of the bank account","title":"Name","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"}},"required":["business_unit_id","currency_code","gl_account_id","id","name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/Batch":{"id":"components/schemas/Batch","kind":"json-schema","title":"Batch","data":{"additionalProperties":false,"properties":{"automatically_close_at":{"description":"Date/time at which this batch should automatically close","format":"date-time","title":"Automatically Close At","type":"string"},"business_unit_id":{"description":"The business unit that the batch belongs in","title":"Business Unit","type":"string"},"closed_at":{"description":"Date the batch was closed","format":"date-time","title":"Closed At","type":"string"},"count":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total # of payments + refunds"},"children":[]}]}]}],"format":"float","title":"Count","type":"number"},"currency_code":{"description":"The currency code in use","maxLength":3,"minLength":3,"title":"Currency Code","type":"string"},"currency_symbol":{"description":"The currency symbol","title":"Currency Symbol","type":"string"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"date":{"description":"The date of the batch","format":"date","title":"Date","type":"string"},"dependents":{"description":"List of batches that depend on this one","items":{"type":"string"},"title":"Dependents","type":"array"},"description":{"description":"Descriptive notes about the batch","title":"Description","type":"string"},"downloaded_at":{"description":"Date the batch was downloaded","format":"date-time","title":"Downloaded At","type":"string"},"downloading_workflow_execution_id":{"description":"The ID of the state machine execution that last downloaded this batch","title":"Downloading Workflow Execution","type":"string"},"errors":{"items":{"additionalProperties":false,"properties":{"error_message":{"title":"Error Message","type":"string"},"transaction_id":{"title":"Transaction","type":"string"},"transaction_type":{"title":"Transaction Type","type":"string"}},"type":"object"},"type":"array"},"fiscal_period":{"description":"The fiscal period of the batch","maximum":12,"minimum":1,"title":"Fiscal Period","type":"integer"},"fiscal_year_id":{"description":"The fiscal year of the business unit","title":"Fiscal Year","type":"string"},"id":{"description":"The unique, string identifier of this batch","pattern":"[\\w|-]+","title":"ID","type":"string"},"name":{"description":"The name of the batch","title":"Name","type":"string"},"posted_at":{"description":"The date the batch was posted","format":"date-time","title":"Posted At","type":"string"},"posting_workflow_execution_id":{"description":"The ID of the state machine execution that posted this batch","title":"Posting Workflow Execution","type":"string"},"recurring_batch_id":{"description":"The recurring batch definition that this batch is tied to","title":"Recurring Batch","type":"string"},"statistics":{"additionalProperties":false,"properties":{"credit_memo_total":{"format":"double","title":"Credit Memo Total","type":"number"},"credit_total":{"format":"double","title":"Credit Total","type":"number"},"debit_memo_total":{"format":"double","title":"Debit Memo Total","type":"number"},"invoice_total":{"format":"double","title":"Invoice Total","type":"number"},"number_of_credit_memos":{"format":"float","title":"Number Of Credit Memos","type":"number"},"number_of_credits":{"format":"float","title":"Number Of Credits","type":"number"},"number_of_debit_memos":{"format":"float","title":"Number Of Debit Memos","type":"number"},"number_of_invoices":{"format":"float","title":"Number Of Invoices","type":"number"},"number_of_payments":{"format":"float","title":"Number Of Payments","type":"number"},"number_of_refunds":{"format":"float","title":"Number Of Refunds","type":"number"},"number_of_write_offs":{"format":"float","title":"Number Of Write Offs","type":"number"},"payment_total":{"format":"double","title":"Payment Total","type":"number"},"refund_total":{"format":"double","title":"Refund Total","type":"number"},"write_off_total":{"format":"double","title":"Write Off Total","type":"number"}},"title":"Statistics","type":"object"},"status":{"enum":["archived","closed","downloaded","error","open","posted","posting","verified"],"title":"Status","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_composite_fiscal_period_key":{"description":"Internal use","title":"Sys Composite Fiscal Period Key","type":"string"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_fiscal_period_id":{"description":"Concatenation of the fiscal year and fiscal period","title":"Sys Fiscal Period","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"total":{"description":"The total amount of payments - refunds for the batch","format":"double","title":"Total","type":"number"},"type":{"description":"Type of batch","enum":["cost of goods sold","deferred revenue","legacy","transaction"],"title":"Type","type":"string"},"unposting_workflow_execution_id":{"description":"The ID of the state machine execution that last unposted this batch","title":"Unposting Workflow Execution","type":"string"}},"required":["business_unit_id","date","fiscal_period","fiscal_year_id","id","name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/BatchAssignmentSetting":{"id":"components/schemas/BatchAssignmentSetting","kind":"json-schema","title":"BatchAssignmentSetting","data":{"additionalProperties":false,"properties":{"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"default_recurring_batch_id":{"description":"The default recurring batch to use, if none of the rules match","title":"Default Recurring Batch","type":"string"},"id":{"description":"The unique, string identifier of this batch assignment setting","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"notes":{"description":"notes","title":"Notes","type":"string"},"rules":{"items":{"additionalProperties":false,"properties":{"bank_account_id":{"description":"The bank account of the transaction","title":"Bank Account","type":"string"},"credit_card_types":{"description":"The credit card types to match with this rule","items":{"enum":["american express","discover","mastercard","other","visa"],"type":"string"},"title":"Credit Card Types","type":"array"},"merchant_account_id":{"description":"The merchant account of the transaction","title":"Merchant Account","type":"string"},"payment_types":{"description":"For payments (and orders with a payment), the types to match","items":{"enum":["ach","bill me later","cash","check","credit card","electronic check","offline credit card","payroll deduction","purchase order","wire transfer"],"type":"string"},"title":"Payment Types","type":"array"},"recurring_batch_id":{"description":"The recurring batch that should be applied to this rule","title":"Recurring Batch","type":"string"},"rule_description":{"description":"A textual description of the rule","title":"Rule Description","type":"string"},"transaction_types":{"description":"The types of transactions to match in this rule","items":{"enum":["cancellation","credit","credit memo","debit memo","invoice","order","payment","refund","return","write off"],"type":"string"},"title":"Transaction Types","type":"array"}},"required":["recurring_batch_id"],"type":"object"},"type":"array"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"}},"required":["default_recurring_batch_id","id","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/BatchDownloadingPayload":{"id":"components/schemas/BatchDownloadingPayload","kind":"json-schema","title":"BatchDownloadingPayload","data":{"additionalProperties":false,"properties":{"batch_ids":{"description":"The IDs of the batches to download","items":{"type":"string"},"minItems":1,"title":"Batches","type":"array"},"business_unit_id":{"description":"The business unit","title":"Business Unit","type":"string"}},"required":["batch_ids","business_unit_id"],"type":"object"}},"components/schemas/BatchOperationRequest":{"id":"components/schemas/BatchOperationRequest","kind":"json-schema","title":"BatchOperationRequest","data":{"additionalProperties":false,"properties":{"operations":{"items":{"additionalProperties":false,"properties":{"id":{"description":"The ID of the record","oneOf":[{"x-required":true}],"title":"ID","type":"string"},"object":{"title":"Object","type":"object"},"operation":{"enum":["create","delete","patch","read","update"],"title":"Operation","type":"string"},"patch_directives":{"items":{"additionalProperties":false,"properties":{"op":{"description":"The operation","enum":["add","copy","move","remove","replace","test"],"title":"Op","type":"string"},"path":{"description":"The JSON path","title":"Path","type":"string"},"value":{"title":"Value","type":"string"}},"required":["op","path"],"type":"object"},"maxItems":100,"minItems":1,"oneOf":[{"x-required":true}],"type":"array"}},"required":["operation"],"type":"object"},"type":"array"}},"type":"object"}},"components/schemas/BatchOperationResponse":{"id":"components/schemas/BatchOperationResponse","kind":"json-schema","title":"BatchOperationResponse","data":{"additionalProperties":false,"properties":{"error_count":{"description":"Number of error results","format":"float","title":"Error Count","type":"number"},"results":{"items":{"additionalProperties":false,"properties":{"error_message":{"title":"Error Message","type":"string"},"id":{"description":"The ID of the record","title":"ID","type":"string"},"object":{"title":"Object","type":"object"},"operation":{"enum":["create","delete","patch","read","update"],"title":"Operation","type":"string"},"outcome":{"enum":["error","no change","success"],"title":"Outcome","type":"string"}},"required":["id","operation"],"type":"object"},"type":"array"},"success_count":{"description":"Number of successful results","format":"float","title":"Success Count","type":"number"}},"type":"object"}},"components/schemas/BatchPreviewResult":{"id":"components/schemas/BatchPreviewResult","kind":"json-schema","title":"BatchPreviewResult","data":{"additionalProperties":false,"properties":{"batches_to_post":{"items":{"additionalProperties":false,"properties":{"date":{"description":"Date of the batch","format":"date-time","title":"Date","type":"string"},"id":{"description":"ID of the ineligible batch","title":"ID","type":"string"},"name":{"description":"Name of the ineligible batch","title":"Name","type":"string"}},"type":"object"},"type":"array"},"ineligible_batches":{"items":{"additionalProperties":false,"properties":{"id":{"description":"ID of the ineligible batch","title":"ID","type":"string"},"name":{"description":"Name of the ineligible batch","title":"Name","type":"string"},"reason":{"description":"Reason the batch is ineligible","title":"Reason","type":"string"}},"type":"object"},"type":"array"},"products":{"items":{"additionalProperties":false,"properties":{"accounting_project_id":{"description":"The accounting project for this project","title":"Accounting Project","type":"string"},"accounts_receivable_gl_account_id":{"description":"The A/R GL account","title":"Accounts Receivable Gl Account","type":"string"},"business_unit_id":{"description":"The product business unit id","title":"Business Unit","type":"string"},"cogs_expense_gl_account_id":{"description":"The COGS account","title":"Cogs Expense Gl Account","type":"string"},"deferred_revenue_gl_account_id":{"description":"The deferred revenue account","oneOf":[{"x-required":true}],"title":"Deferred Revenue Gl Account","type":"string"},"id":{"description":"The product id","title":"ID","type":"string"},"inventory_gl_account_id":{"description":"The inventory gl account","title":"Inventory Gl Account","type":"string"},"name":{"description":"The name of the product","title":"Name","type":"string"},"revenue_gl_account_id":{"description":"The revenue GL account","title":"Revenue Gl Account","type":"string"},"type":{"description":"The type of the product","title":"Type","type":"string"},"write_off_gl_account_id":{"description":"The write off account","title":"Write Off Gl Account","type":"string"}},"required":["revenue_gl_account_id"],"type":"object"},"type":"array"},"products_without_financial_configuration":{"items":{"additionalProperties":false,"properties":{"business_unit_id":{"description":"The product business unit id","title":"Business Unit","type":"string"},"id":{"description":"The product id","title":"ID","type":"string"},"name":{"description":"The name of the product","title":"Name","type":"string"},"type":{"description":"The type of the product","title":"Type","type":"string"}},"type":"object"},"type":"array"}},"type":"object"}},"components/schemas/BatchSearchParameters":{"id":"components/schemas/BatchSearchParameters","kind":"json-schema","title":"BatchSearchParameters","data":{"additionalProperties":false,"properties":{"business_unit_id":{"title":"Business Unit","type":"string"},"count":{"items":{"type":"string"},"maxItems":2,"minItems":2,"title":"Count","type":"array"},"date":{"items":{"type":"string"},"maxItems":2,"minItems":2,"title":"Date","type":"array"},"fiscal_period":{"format":"float","maximum":12,"minimum":1,"title":"Fiscal Period","type":"number"},"fiscal_year_id":{"title":"Fiscal Year","type":"string"},"id":{"items":{"type":"string"},"title":"ID","type":"array"},"name":{"title":"Name","type":"string"},"recurring_batch_id":{"items":{"type":"string"},"title":"Recurring Batch","type":"array"},"status":{"items":{"enum":["closed","downloaded","error","open","posted","posting","verified"],"type":"string"},"title":"Status","type":"array"},"total":{"items":{"type":"string"},"maxItems":2,"minItems":2,"title":"Total","type":"array"},"type":{"items":{"enum":["cost of goods sold","deferred revenue","transaction"],"type":"string"},"title":"Type","type":"array"}},"type":"object"}},"components/schemas/BatchSearchResults":{"id":"components/schemas/BatchSearchResults","kind":"json-schema","title":"BatchSearchResults","data":{"additionalProperties":false,"properties":{"business_unit_id":{"title":"Business Unit","type":"string"},"date":{"format":"date-time","title":"Date","type":"string"},"fiscal_period":{"format":"float","maximum":12,"minimum":1,"title":"Fiscal Period","type":"number"},"fiscal_year_id":{"title":"Fiscal Year","type":"string"},"id":{"title":"ID","type":"string"},"name":{"title":"Name","type":"string"},"recurring_batch_id":{"title":"Recurring Batch","type":"string"},"status":{"enum":["closed","downloaded","error","open","posted","posting","verified"],"title":"Status","type":"string"},"type":{"enum":["cost of goods sold","deferred revenue","transaction"],"title":"Type","type":"string"}},"required":["business_unit_id","fiscal_period","fiscal_year_id"],"type":"object"}},"components/schemas/BatchTemplate":{"id":"components/schemas/BatchTemplate","kind":"json-schema","title":"BatchTemplate","data":{"additionalProperties":false,"properties":{"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"file_name_template":{"description":"File name template for the download file","title":"File Name Template","type":"string"},"id":{"description":"The unique, string identifier of this batch download template","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether or not the template is active","title":"Is Active","type":"boolean"},"name":{"description":"The name of the batch download template","title":"Name","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"template":{"description":"The handlebars template used to generate the download file","title":"Template","type":"string"}},"required":["id","name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id","template"],"type":"object"}},"components/schemas/BillingNotice":{"id":"components/schemas/BillingNotice","kind":"json-schema","title":"BillingNotice","data":{"additionalProperties":false,"properties":{"contact_role_ids":{"items":{"type":"string"},"minItems":1,"title":"Contact Roles","type":"array"},"email":{"additionalProperties":false,"properties":{"bcc":{"description":"Anyone that should be bcc'ed on the email","title":"Bcc","type":"string"},"body":{"description":"The email body","title":"Body","type":"string"},"cc":{"description":"Anyone that should be cc'ed on the email","title":"Cc","type":"string"},"from":{"description":"From email address","title":"From","type":"string"},"from_name":{"description":"From name","title":"From Name","type":"string"},"reply_to":{"description":"The reply to","title":"Reply To","type":"string"},"subject":{"description":"The email subject","title":"Subject","type":"string"}},"required":["body","subject"],"title":"Email","type":"object"},"id":{"description":"The unique, string identifier of this billing notice","pattern":"^[\\w:|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether or not this billing notice is active","title":"Is Active","type":"boolean"},"name":{"description":"The name of the billing notice","title":"Name","type":"string"},"send_to":{"description":"Whether to send notices to all contacts, or specific roles","enum":["all contacts","only certain roles"],"title":"Send To","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"}},"required":["contact_role_ids","email","id","name","send_to","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/BillingRun":{"id":"components/schemas/BillingRun","kind":"json-schema","title":"BillingRun","data":{"additionalProperties":false,"properties":{"business_unit_id":{"title":"Business Unit","type":"string"},"cancel_installment_schedules":{"description":"If set, reminders are sent to those who have failed installments","title":"Cancel Installment Schedules","type":"boolean"},"error":{"description":"The error message","title":"Error","type":"string"},"error_stack":{"description":"The error stack","title":"Error Stack","type":"string"},"expiring_credit_card_reminder_options":{"additionalProperties":false,"properties":{"order_type_restriction":{"description":"Determines if/how to restrict the type of orders to ","enum":["exclude","include","none"],"title":"Order Type Restriction","type":"string"},"order_types":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Order Types","type":"array"},"reminders":{"items":{"additionalProperties":false,"properties":{"card_expiration_date_end":{"description":"Credit card expiration date","title":"Card Expiration Date End","type":"string"},"card_expiration_date_start":{"description":"Credit card expiration date","title":"Card Expiration Date Start","type":"string"},"id":{"description":"A unique, unchangeable reminder id","format":"float","title":"ID","type":"number"},"name":{"description":"Optional name","title":"Name","type":"string"},"notice_id":{"description":"The notice to send to the customer","title":"Notice","type":"string"}},"required":["card_expiration_date_end","card_expiration_date_start","notice_id"],"type":"object"},"type":"array"}},"title":"Expiring Credit Card Reminder Options","type":"object"},"id":{"description":"The unique, string identifier of this billing run","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"installment_schedule_cancellation_options":{"additionalProperties":false,"properties":{"date_range_end":{"description":"Date used to filter out schedules to cancel","title":"Date Range End","type":"string"},"date_range_start":{"description":"Date used to filter out schedules to cancel","title":"Date Range Start","type":"string"},"notice_id":{"description":"The notice to send to the customer","title":"Notice","type":"string"},"order_type_restriction":{"description":"Determines if/how to restrict the type of orders to ","enum":["exclude","include","none"],"title":"Order Type Restriction","type":"string"},"order_types":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Order Types","type":"array"}},"required":["date_range_end","date_range_start"],"title":"Installment Schedule Cancellation Options","type":"object"},"installment_schedule_options":{"additionalProperties":false,"properties":{"card_type_restriction":{"description":"Determines if/how to restrict the type of invoices to ","enum":["exclude","include","none"],"title":"Card Type Restriction","type":"string"},"card_types":{"items":{"enum":["american express","discover","electronic check","mastercard","other","visa"],"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Card Types","type":"array"},"date_range_end":{"description":"Date used to filter out schedules to bill","title":"Date Range End","type":"string"},"date_range_start":{"description":"Date used to filter out schedules to bill","title":"Date Range Start","type":"string"},"do_not_send_standard_email_confirmations":{"description":"If true, the normal payment/order confirmations are not sent","title":"Do Not Send Standard Email Confirmations","type":"boolean"},"failure_notice_id":{"description":"The notice to send if processing is unsuccessful","title":"Failure Notice","type":"string"},"order_type_restriction":{"description":"Determines if/how to restrict the type of orders to ","enum":["exclude","include","none"],"title":"Order Type Restriction","type":"string"},"order_types":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Order Types","type":"array"},"payment_type_restriction":{"description":"Determines if/how to restrict the type of invoices to ","enum":["exclude","include","none"],"title":"Payment Type Restriction","type":"string"},"payment_types":{"items":{"enum":["credit card","electronic check","none"],"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Payment Types","type":"array"},"success_notice_id":{"description":"The notice to send if processing is successful","title":"Success Notice","type":"string"}},"required":["date_range_end","date_range_start"],"title":"Installment Schedule Options","type":"object"},"installment_schedule_reminder_options":{"additionalProperties":false,"properties":{"order_type_restriction":{"description":"Determines if/how to restrict the type of orders to ","enum":["exclude","include","none"],"title":"Order Type Restriction","type":"string"},"order_types":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Order Types","type":"array"},"reminders":{"items":{"additionalProperties":false,"properties":{"date_range_end":{"description":"Date used to filter out schedules to send reminders","title":"Date Range End","type":"string"},"date_range_start":{"description":"Date used to filter out schedules to send reminders","title":"Date Range Start","type":"string"},"id":{"description":"A unique, unchangeable reminder id","format":"float","title":"ID","type":"number"},"name":{"description":"Optional name","title":"Name","type":"string"},"notice_id":{"description":"The reminder notice","title":"Notice","type":"string"}},"required":["date_range_end","date_range_start","notice_id"],"type":"object"},"minItems":1,"type":"array"}},"required":["reminders"],"title":"Installment Schedule Reminder Options","type":"object"},"last_refresh_date":{"description":"The last time the billing run was refreshed","format":"date-time","title":"Last Refresh Date","type":"string"},"name":{"description":"The name of the billing run","title":"Name","type":"string"},"notification_email":{"description":"Te address to send notifications","title":"Notification Email","type":"string"},"preprocessing_date":{"description":"The date this billing run was actually processed","format":"date-time","title":"Preprocessing Date","type":"string"},"process_installment_schedules":{"description":"If set, installment schedules should be processed","title":"Process Installment Schedules","type":"boolean"},"recurring_billing_run_id":{"description":"The recurring billing run","title":"Recurring Billing Run","type":"string"},"run_date":{"description":"The date of the billing run","format":"date-time","title":"Run Date","type":"string"},"scheduled_preprocessing_date":{"description":"The date which this billing run should be preprocessed","format":"date-time","title":"Scheduled Preprocessing Date","type":"string"},"scheduled_run_date":{"description":"The date the billing run is scheduled for execution","format":"date-time","title":"Scheduled Run Date","type":"string"},"send_expiring_credit_card_reminders":{"description":"If set, reminders are sent to those whose credit cards are about to expire","title":"Send Expiring Credit Card Reminders","type":"boolean"},"send_installment_schedule_reminders":{"description":"If set, reminders are to customers who own installment schedules suspended due to payment error","title":"Send Installment Schedule Reminders","type":"boolean"},"send_statements":{"description":"If set, statements are generated for those who have open invoices","title":"Send Statements","type":"boolean"},"statement_options":{"additionalProperties":false,"properties":{"business_unit_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Business Units","type":"array"},"business_unit_restriction":{"description":"Determines if/how to restrict the type of invoices to ","enum":["exclude","include","none"],"title":"Business Unit Restriction","type":"string"},"customer_type":{"description":"The type of customer for whom statements should be generated","enum":["both","contact","organization"],"title":"Customer Type","type":"string"},"order_type_restriction":{"description":"Determines if/how to restrict the type of orders to ","enum":["exclude","include","none"],"title":"Order Type Restriction","type":"string"},"order_types":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Order Types","type":"array"},"statement_template_id":{"description":"The statement template to use; leave blank for default","title":"Statement Template","type":"string"}},"title":"Statement Options","type":"object"},"statistics":{"items":{"additionalProperties":false,"properties":{"action":{"title":"Action","type":"string"},"error":{"format":"float","title":"Error","type":"number"},"excluded":{"format":"float","title":"Excluded","type":"number"},"pending":{"format":"float","title":"Pending","type":"number"},"processing":{"format":"float","title":"Processing","type":"number"},"successful":{"format":"float","title":"Successful","type":"number"},"total":{"format":"float","title":"Total","type":"number"}},"required":["action"],"type":"object"},"type":"array"},"status":{"enum":["cancelled","completed","draft","error","preprocessing","ready for execution","running","scheduled","scheduled for execution","timed out"],"title":"Status","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"template_id":{"description":"The billing template that created this run","title":"Template","type":"string"}},"required":["business_unit_id","expiring_credit_card_reminder_options","id","installment_schedule_cancellation_options","installment_schedule_options","installment_schedule_reminder_options","name","statement_options","status","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/BillingRunAction":{"id":"components/schemas/BillingRunAction","kind":"json-schema","title":"BillingRunAction","data":{"additionalProperties":false,"properties":{"billing_notice_id":{"description":"The billing notice","title":"Billing Notice","type":"string"},"billing_run_id":{"description":"The billing run ID","title":"Billing Run","type":"string"},"candidate_id":{"description":"The candidate to which this action is linked","title":"Candidate","type":"string"},"candidate_service":{"description":"The service of the candidate","title":"Candidate Service","type":"string"},"city":{"description":"The member city","title":"City","type":"string"},"contact_id":{"title":"Contact","type":"string"},"contact_name":{"description":"The name of the contact","title":"Contact Name","type":"string"},"country":{"description":"The member country","title":"Country","type":"string"},"customer_id":{"description":"The contact or organization ID","title":"Customer","type":"string"},"customer_type":{"enum":["contact","organization"],"title":"Customer Type","type":"string"},"date":{"description":"The applicable date","title":"Date","type":"string"},"email_address":{"description":"The member's email address","title":"Email Address","type":"string"},"error_message":{"description":"The error message","title":"Error Message","type":"string"},"error_stack":{"description":"A detailed error message with stack trace","title":"Error Stack","type":"string"},"execution_arn":{"description":"If tied to a step function, the execution ARN","title":"Execution Arn","type":"string"},"failed_billing_notice_id":{"description":"The notice to send when processing fails","title":"Failed Billing Notice","type":"string"},"first_name":{"description":"The member's first name","title":"First Name","type":"string"},"id":{"description":"The unique, string identifier of this billing run action","pattern":"^[\\w:|-]+$","title":"ID","type":"string"},"installment_schedule_id":{"description":"The installment schedule ID","title":"Installment Schedule","type":"string"},"invoice_id":{"description":"The invoice ID affected by this action","title":"Invoice","type":"string"},"job_title":{"description":"The member job title","title":"Job Title","type":"string"},"last_name":{"description":"The member's last name","title":"Last Name","type":"string"},"last_refresh_date":{"description":"The date this action was last refreshed","format":"date-time","title":"Last Refresh Date","type":"string"},"name":{"description":"Name of the membership","title":"Name","type":"string"},"order_id":{"description":"The order ID affected by this action","title":"Order","type":"string"},"organization_id":{"title":"Organization","type":"string"},"organization_name":{"description":"The name of the organization","title":"Organization Name","type":"string"},"outcome_of_last_refresh":{"description":"Describes what happened to this action the last time this billing run was refreshed","enum":["added","no change","removed"],"title":"Outcome Of Last Refresh","type":"string"},"state":{"description":"The state","title":"State","type":"string"},"status":{"description":"The status of this action","enum":["completed","error","excluded","expiration date changed","no longer eligible","payment failure","pending","processing","processing order"],"title":"Status","type":"string"},"step_function_execution_arn":{"description":"The step function arn","title":"Step Function Execution Arn","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"type":{"enum":["cancel installment schedule","installment schedule reminder","process installment schedule","remind expiring credit card","send statement"],"title":"Type","type":"string"}},"required":["billing_notice_id","billing_run_id","candidate_id","candidate_service","contact_id","customer_id","customer_type","date","id","installment_schedule_id","invoice_id","name","order_id","organization_id","status","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id","type"],"type":"object"}},"components/schemas/BillingRunSearchParameters":{"id":"components/schemas/BillingRunSearchParameters","kind":"json-schema","title":"BillingRunSearchParameters","data":{"additionalProperties":false,"properties":{"activate_applications":{"items":{"type":"boolean"},"title":"Activate Applications","type":"array"},"application_expiration_options":{"items":{"type":"boolean"},"title":"Application Expiration Options","type":"array"},"bill_training_providers":{"items":{"type":"boolean"},"title":"Bill Training Providers","type":"array"},"ids":{"description":"IDs to search","items":{"type":"string"},"title":"Ids","type":"array"},"name":{"title":"Name","type":"string"},"perform_drops":{"items":{"type":"boolean"},"title":"Perform Drops","type":"array"},"run_date":{"items":{"type":"string"},"maxItems":2,"minItems":2,"title":"Run Date","type":"array"},"scheduled_run_date":{"items":{"type":"string"},"maxItems":2,"minItems":2,"title":"Scheduled Run Date","type":"array"},"send_application_reminders":{"items":{"type":"boolean"},"title":"Send Application Reminders","type":"array"},"send_renewal_reminders":{"items":{"type":"boolean"},"title":"Send Renewal Reminders","type":"array"},"status":{"items":{"type":"string"},"title":"Status","type":"array"}},"type":"object"}},"components/schemas/BillingRunSearchResults":{"id":"components/schemas/BillingRunSearchResults","kind":"json-schema","title":"BillingRunSearchResults","data":{"additionalProperties":false,"properties":{"generate_renewal_notices":{"title":"Generate Renewal Notices","type":"boolean"},"generate_renewal_orders":{"title":"Generate Renewal Orders","type":"boolean"},"ids":{"description":"IDs to search","items":{"type":"string"},"title":"Ids","type":"array"},"name":{"title":"Name","type":"string"},"perform_auto_renewals":{"title":"Perform Auto Renewals","type":"boolean"},"perform_drops":{"title":"Perform Drops","type":"boolean"},"run_date":{"title":"Run Date","type":"string"},"scheduled_run_date":{"title":"Scheduled Run Date","type":"string"},"send_auto_renewal_reminders":{"title":"Send Auto Renewal Reminders","type":"boolean"},"send_expiring_credit_card_reminders":{"title":"Send Expiring Credit Card Reminders","type":"boolean"},"send_renewal_reminders":{"title":"Send Renewal Reminders","type":"boolean"},"status":{"title":"Status","type":"string"}},"type":"object"}},"components/schemas/BillingTemplate":{"id":"components/schemas/BillingTemplate","kind":"json-schema","title":"BillingTemplate","data":{"additionalProperties":false,"properties":{"business_unit_id":{"title":"Business Unit","type":"string"},"cancel_installment_schedules":{"description":"If set, reminders are sent to those who have failed installments","title":"Cancel Installment Schedules","type":"boolean"},"description":{"description":"A description of the template","title":"Description","type":"string"},"expiring_credit_card_reminder_options":{"additionalProperties":false,"properties":{"order_type_restriction":{"description":"Determines if/how to restrict the type of orders to ","enum":["exclude","include","none"],"title":"Order Type Restriction","type":"string"},"order_types":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Order Types","type":"array"},"reminders":{"items":{"additionalProperties":false,"properties":{"card_expiration_date_end":{"additionalProperties":false,"description":"Credit card expiration date","properties":{"number":{"description":"The unit of time","format":"float","minimum":0,"oneOf":[{}],"title":"Number","type":"number"},"position":{"description":"How the unit relates to the reference date","enum":["after","before","on"],"title":"Position","type":"string"},"relative_to":{"enum":["the beginning of the month","the beginning of the quarter","the beginning of the week","the beginning of the year","the end of the month","the end of the quarter","the end of the week","the end of the year","the reference date"],"title":"Relative To","type":"string"},"unit_of_time":{"enum":["days","months","weeks","years"],"oneOf":[{}],"title":"Unit Of Time","type":"string"}},"required":["number","position","relative_to","unit_of_time"],"title":"Card Expiration Date End","type":"object"},"card_expiration_date_start":{"additionalProperties":false,"description":"Credit card expiration date","properties":{"number":{"description":"The unit of time","format":"float","minimum":0,"oneOf":[{}],"title":"Number","type":"number"},"position":{"description":"How the unit relates to the reference date","enum":["after","before","on"],"title":"Position","type":"string"},"relative_to":{"enum":["the beginning of the month","the beginning of the quarter","the beginning of the week","the beginning of the year","the end of the month","the end of the quarter","the end of the week","the end of the year","the reference date"],"title":"Relative To","type":"string"},"unit_of_time":{"enum":["days","months","weeks","years"],"oneOf":[{}],"title":"Unit Of Time","type":"string"}},"required":["number","position","relative_to","unit_of_time"],"title":"Card Expiration Date Start","type":"object"},"id":{"description":"A unique, unchangeable reminder id","format":"float","title":"ID","type":"number"},"name":{"description":"Optional name","title":"Name","type":"string"},"notice_id":{"description":"The notice to send to the customer","title":"Notice","type":"string"}},"required":["card_expiration_date_end","card_expiration_date_start","notice_id"],"type":"object"},"type":"array"}},"title":"Expiring Credit Card Reminder Options","type":"object"},"id":{"description":"The unique, string identifier of this billing template","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"installment_schedule_cancellation_options":{"additionalProperties":false,"properties":{"date_range_end":{"additionalProperties":false,"description":"Date used to filter out schedules to cancel","properties":{"number":{"description":"The unit of time","format":"float","minimum":0,"oneOf":[{}],"title":"Number","type":"number"},"position":{"description":"How the unit relates to the reference date","enum":["after","before","on"],"title":"Position","type":"string"},"relative_to":{"enum":["the beginning of the month","the beginning of the quarter","the beginning of the week","the beginning of the year","the end of the month","the end of the quarter","the end of the week","the end of the year","the reference date"],"title":"Relative To","type":"string"},"unit_of_time":{"enum":["days","months","weeks","years"],"oneOf":[{}],"title":"Unit Of Time","type":"string"}},"required":["number","position","relative_to","unit_of_time"],"title":"Date Range End","type":"object"},"date_range_start":{"additionalProperties":false,"description":"Date used to filter out schedules to cancel","properties":{"number":{"description":"The unit of time","format":"float","minimum":0,"oneOf":[{}],"title":"Number","type":"number"},"position":{"description":"How the unit relates to the reference date","enum":["after","before","on"],"title":"Position","type":"string"},"relative_to":{"enum":["the beginning of the month","the beginning of the quarter","the beginning of the week","the beginning of the year","the end of the month","the end of the quarter","the end of the week","the end of the year","the reference date"],"title":"Relative To","type":"string"},"unit_of_time":{"enum":["days","months","weeks","years"],"oneOf":[{}],"title":"Unit Of Time","type":"string"}},"required":["number","position","relative_to","unit_of_time"],"title":"Date Range Start","type":"object"},"notice_id":{"description":"The notice to send to the customer","title":"Notice","type":"string"},"order_type_restriction":{"description":"Determines if/how to restrict the type of orders to ","enum":["exclude","include","none"],"title":"Order Type Restriction","type":"string"},"order_types":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Order Types","type":"array"}},"required":["date_range_end","date_range_start"],"title":"Installment Schedule Cancellation Options","type":"object"},"installment_schedule_options":{"additionalProperties":false,"properties":{"card_type_restriction":{"description":"Determines if/how to restrict the type of invoices to ","enum":["exclude","include","none"],"title":"Card Type Restriction","type":"string"},"card_types":{"items":{"enum":["american express","discover","electronic check","mastercard","other","visa"],"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Card Types","type":"array"},"date_range_end":{"additionalProperties":false,"description":"Date used to filter out schedules to bill","properties":{"number":{"description":"The unit of time","format":"float","minimum":0,"oneOf":[{}],"title":"Number","type":"number"},"position":{"description":"How the unit relates to the reference date","enum":["after","before","on"],"title":"Position","type":"string"},"relative_to":{"enum":["the beginning of the month","the beginning of the quarter","the beginning of the week","the beginning of the year","the end of the month","the end of the quarter","the end of the week","the end of the year","the reference date"],"title":"Relative To","type":"string"},"unit_of_time":{"enum":["days","months","weeks","years"],"oneOf":[{}],"title":"Unit Of Time","type":"string"}},"required":["number","position","relative_to","unit_of_time"],"title":"Date Range End","type":"object"},"date_range_start":{"additionalProperties":false,"description":"Date used to filter out schedules to bill","properties":{"number":{"description":"The unit of time","format":"float","minimum":0,"oneOf":[{}],"title":"Number","type":"number"},"position":{"description":"How the unit relates to the reference date","enum":["after","before","on"],"title":"Position","type":"string"},"relative_to":{"enum":["the beginning of the month","the beginning of the quarter","the beginning of the week","the beginning of the year","the end of the month","the end of the quarter","the end of the week","the end of the year","the reference date"],"title":"Relative To","type":"string"},"unit_of_time":{"enum":["days","months","weeks","years"],"oneOf":[{}],"title":"Unit Of Time","type":"string"}},"required":["number","position","relative_to","unit_of_time"],"title":"Date Range Start","type":"object"},"do_not_send_standard_email_confirmations":{"description":"If true, the normal payment/order confirmations are not sent","title":"Do Not Send Standard Email Confirmations","type":"boolean"},"failure_notice_id":{"description":"The notice to send if processing is unsuccessful","title":"Failure Notice","type":"string"},"order_type_restriction":{"description":"Determines if/how to restrict the type of orders to ","enum":["exclude","include","none"],"title":"Order Type Restriction","type":"string"},"order_types":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Order Types","type":"array"},"payment_type_restriction":{"description":"Determines if/how to restrict the type of invoices to ","enum":["exclude","include","none"],"title":"Payment Type Restriction","type":"string"},"payment_types":{"items":{"enum":["credit card","electronic check","none"],"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Payment Types","type":"array"},"success_notice_id":{"description":"The notice to send if processing is successful","title":"Success Notice","type":"string"}},"required":["date_range_end","date_range_start"],"title":"Installment Schedule Options","type":"object"},"installment_schedule_reminder_options":{"additionalProperties":false,"properties":{"order_type_restriction":{"description":"Determines if/how to restrict the type of orders to ","enum":["exclude","include","none"],"title":"Order Type Restriction","type":"string"},"order_types":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Order Types","type":"array"},"reminders":{"items":{"additionalProperties":false,"properties":{"date_range_end":{"additionalProperties":false,"description":"Date used to filter out schedules to send reminders","properties":{"number":{"description":"The unit of time","format":"float","minimum":0,"oneOf":[{}],"title":"Number","type":"number"},"position":{"description":"How the unit relates to the reference date","enum":["after","before","on"],"title":"Position","type":"string"},"relative_to":{"enum":["the beginning of the month","the beginning of the quarter","the beginning of the week","the beginning of the year","the end of the month","the end of the quarter","the end of the week","the end of the year","the reference date"],"title":"Relative To","type":"string"},"unit_of_time":{"enum":["days","months","weeks","years"],"oneOf":[{}],"title":"Unit Of Time","type":"string"}},"required":["number","position","relative_to","unit_of_time"],"title":"Date Range End","type":"object"},"date_range_start":{"additionalProperties":false,"description":"Date used to filter out schedules to send reminders","properties":{"number":{"description":"The unit of time","format":"float","minimum":0,"oneOf":[{}],"title":"Number","type":"number"},"position":{"description":"How the unit relates to the reference date","enum":["after","before","on"],"title":"Position","type":"string"},"relative_to":{"enum":["the beginning of the month","the beginning of the quarter","the beginning of the week","the beginning of the year","the end of the month","the end of the quarter","the end of the week","the end of the year","the reference date"],"title":"Relative To","type":"string"},"unit_of_time":{"enum":["days","months","weeks","years"],"oneOf":[{}],"title":"Unit Of Time","type":"string"}},"required":["number","position","relative_to","unit_of_time"],"title":"Date Range Start","type":"object"},"id":{"description":"A unique, unchangeable reminder id","format":"float","title":"ID","type":"number"},"name":{"description":"Optional name","title":"Name","type":"string"},"notice_id":{"description":"The reminder notice","title":"Notice","type":"string"}},"required":["date_range_end","date_range_start","notice_id"],"type":"object"},"minItems":1,"type":"array"}},"required":["reminders"],"title":"Installment Schedule Reminder Options","type":"object"},"is_active":{"description":"Whether or not the template is active","title":"Is Active","type":"boolean"},"name":{"description":"The name of the billing template","title":"Name","type":"string"},"notification_email":{"description":"Te address to send notifications","title":"Notification Email","type":"string"},"process_installment_schedules":{"description":"If set, installment schedules should be processed","title":"Process Installment Schedules","type":"boolean"},"send_expiring_credit_card_reminders":{"description":"If set, reminders are sent to those whose credit cards are about to expire","title":"Send Expiring Credit Card Reminders","type":"boolean"},"send_installment_schedule_reminders":{"description":"If set, reminders are to customers who own installment schedules suspended due to payment error","title":"Send Installment Schedule Reminders","type":"boolean"},"send_statements":{"description":"If set, statements are generated for those who have open invoices","title":"Send Statements","type":"boolean"},"statement_options":{"additionalProperties":false,"properties":{"business_unit_ids":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Business Units","type":"array"},"business_unit_restriction":{"description":"Determines if/how to restrict the type of invoices to ","enum":["exclude","include","none"],"title":"Business Unit Restriction","type":"string"},"customer_type":{"description":"The type of customer for whom statements should be generated","enum":["both","contact","organization"],"title":"Customer Type","type":"string"},"order_type_restriction":{"description":"Determines if/how to restrict the type of orders to ","enum":["exclude","include","none"],"title":"Order Type Restriction","type":"string"},"order_types":{"items":{"type":"string"},"minItems":1,"oneOf":[{"x-required":true}],"title":"Order Types","type":"array"},"statement_template_id":{"description":"The statement template to use; leave blank for default","title":"Statement Template","type":"string"}},"title":"Statement Options","type":"object"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"}},"required":["business_unit_id","expiring_credit_card_reminder_options","id","installment_schedule_cancellation_options","installment_schedule_options","installment_schedule_reminder_options","name","statement_options","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/BusinessUnit":{"id":"components/schemas/BusinessUnit","kind":"json-schema","title":"BusinessUnit","data":{"additionalProperties":false,"properties":{"accounting_method":{"description":"The accounting method for generating subledger entries","enum":["accrual","cash"],"title":"Accounting Method","type":"string"},"ar_gl_account_id":{"description":"The default A/R account","title":"Ar Gl Account","type":"string"},"automatic_batch_download_options":{"additionalProperties":false,"properties":{"accounting_integration_account_id":{"description":"The ID of the accounting integration service","title":"Accounting Integration Account","type":"string"},"accounting_integration_service":{"enum":["integration-qbo-accounts"],"title":"Accounting Integration Service","type":"string"}},"required":["accounting_integration_account_id","accounting_integration_service"],"title":"Automatic Batch Download Options","type":"object"},"bad_debts_expense_gl_account_id":{"description":"The default A/R account","title":"Bad Debts Expense Gl Account","type":"string"},"base_currency_code":{"description":"The base currency for the business unit","maxLength":3,"minLength":3,"title":"Base Currency Code","type":"string"},"base_currency_symbol":{"description":"The base symbol for the business unit","title":"Base Currency Symbol","type":"string"},"batch_download_method":{"enum":["batch-level summary","detail","summary"],"title":"Batch Download Method","type":"string"},"cogs_expense_gl_account_id":{"description":"The default COGS expense account","title":"Cogs Expense Gl Account","type":"string"},"currency_trading_gl_account_id":{"description":"The default A/R account","title":"Currency Trading Gl Account","type":"string"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"default_write_off_method":{"enum":["allowance","direct"],"title":"Default Write Off Method","type":"string"},"deferred_revenue_gl_account_id":{"description":"The default A/R account","title":"Deferred Revenue Gl Account","type":"string"},"description":{"description":"Any descriptive information about the business unit","title":"Description","type":"string"},"download_template_id":{"description":"The optional template to use to format the financial download file","title":"Download Template","type":"string"},"due_to_due_from_entries":{"items":{"additionalProperties":false,"properties":{"accounts_receivable_gl_account_id":{"description":"The A/R G/L","title":"Accounts Receivable Gl Account","type":"string"},"business_unit_id":{"description":"The business unit","title":"Business Unit","type":"string"},"liability_gl_account_id":{"description":"The liability G/L account ID","title":"Liability Gl Account","type":"string"}},"required":["accounts_receivable_gl_account_id","business_unit_id","liability_gl_account_id"],"type":"object"},"minItems":1,"type":"array"},"enable_automatic_batch_downloads":{"description":"When enabled, batches are automatically synced with users accounting software","title":"Enable Automatic Batch Downloads","type":"boolean"},"enable_multi_currency":{"description":"Whether or not multi-currency is turned on for this business unit","title":"Enable Multi Currency","type":"boolean"},"financial_software_package":{"enum":["great plains","netsuite","other","peachtree","quickbooks","quickbooks online","sage intacct"],"title":"Financial Software Package","type":"string"},"id":{"description":"The unique, string identifier of this business unit","pattern":"^\\w+$","title":"ID","type":"string"},"inventory_costing_method":{"enum":["do not calculate","fifo","lifo"],"title":"Inventory Costing Method","type":"string"},"inventory_gl_account_id":{"description":"The default A/R account","title":"Inventory Gl Account","type":"string"},"invoice_template_id":{"description":"Teh default invoice template to use for printing invoices","title":"Invoice Template","type":"string"},"is_active":{"description":"Whether or not this business unit is active","title":"Is Active","type":"boolean"},"missing_product_revenue_gl_account_id":{"description":"The G/L account for missing products","title":"Missing Product Revenue Gl Account","type":"string"},"name":{"description":"The name of the business unit","title":"Name","type":"string"},"overpayment_liability_gl_account_id":{"description":"The default A/R account","title":"Overpayment Liability Gl Account","type":"string"},"payment_receipt_email":{"additionalProperties":false,"properties":{"bcc":{"description":"Anyone that should be bcc'ed on the email","title":"Bcc","type":"string"},"body":{"description":"The email body","title":"Body","type":"string"},"cc":{"description":"Anyone that should be cc'ed on the email","title":"Cc","type":"string"},"from":{"description":"From email address","title":"From","type":"string"},"from_name":{"description":"From name","title":"From Name","type":"string"},"reply_to":{"description":"The reply to","title":"Reply To","type":"string"},"subject":{"description":"The email subject","title":"Subject","type":"string"}},"required":["body","subject"],"title":"Payment Receipt Email","type":"object"},"payment_receipt_template_id":{"description":"Teh default payment template to use for printing payment receipts","title":"Payment Receipt Template","type":"string"},"priority":{"description":"A priority number that determines how this is displayed; lower numbers indicate higher priority","format":"float","title":"Priority","type":"number"},"quickbooks_online_account_id":{"description":"The quickbooks online account tied to the business unit","title":"Quickbooks Online Account","type":"string"},"refund_receipt_email":{"additionalProperties":false,"properties":{"bcc":{"description":"Anyone that should be bcc'ed on the email","title":"Bcc","type":"string"},"body":{"description":"The email body","title":"Body","type":"string"},"cc":{"description":"Anyone that should be cc'ed on the email","title":"Cc","type":"string"},"from":{"description":"From email address","title":"From","type":"string"},"from_name":{"description":"From name","title":"From Name","type":"string"},"reply_to":{"description":"The reply to","title":"Reply To","type":"string"},"subject":{"description":"The email subject","title":"Subject","type":"string"}},"required":["body","subject"],"title":"Refund Receipt Email","type":"object"},"refund_receipt_template_id":{"description":"Teh default template to use for printing refund receipts","title":"Refund Receipt Template","type":"string"},"start_of_fiscal_year":{"description":"The starting month of the fiscal year, between 1-12","maximum":12,"minimum":1,"title":"Start Of Fiscal Year","type":"integer"},"store_credit_gl_account_id":{"description":"The default A/R account","title":"Store Credit Gl Account","type":"string"},"supported_currencies":{"items":{"additionalProperties":false,"properties":{"currency_code":{"enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHF","CLP","CNY","COP","CRC","CUC","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GQE","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZM","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SYP","SZL","THB","TJS","TMT","TND","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYU","UZS","VEB","VND","VUV","WST","XAF","XCD","XDR","XOF","XPF","YER","ZAR","ZMK","ZWR"],"maxLength":3,"minLength":3,"title":"Currency Code","type":"string"}},"required":["currency_code"],"type":"object"},"minItems":1,"type":"array"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"}},"required":["automatic_batch_download_options","base_currency_code","batch_download_method","default_write_off_method","id","inventory_costing_method","name","start_of_fiscal_year","supported_currencies","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/CheckRequest":{"id":"components/schemas/CheckRequest","kind":"json-schema","title":"CheckRequest","data":{"additionalProperties":false,"properties":{"business_unit_id":{"description":"The business unit that this request belongs to","title":"Business Unit","type":"string"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"date":{"description":"The date of the request","format":"date-time","title":"Date","type":"string"},"id":{"description":"The unique, string identifier of this check request","pattern":"^[\\w-|:]+$","title":"ID","type":"string"},"is_active":{"description":"Whether or not this check request is active","title":"Is Active","type":"boolean"},"items":{"description":"Items associated with request","items":{"additionalProperties":false,"properties":{"batch_id":{"description":"The batch id for the item associated with the request","title":"Batch","type":"string"},"customer_id":{"description":"The customer for the item associated with the request","title":"Customer","type":"string"},"date":{"description":"The date for the item associated with the request","format":"date-time","title":"Date","type":"string"},"gl_account_id":{"description":"The subledger entry for the item associated with the request","title":"Gl Account","type":"string"},"invoice_id":{"description":"The invoice entry for the item associated with the request","title":"Invoice","type":"string"},"invoice_line_item_id":{"description":"The invoice line item for the item associated with the request","title":"Invoice Line Item","type":"string"},"name":{"description":"The name for the item associated with the request","title":"Name","type":"string"},"subledger_entry_id":{"description":"The subledger entry for the item associated with the request","title":"Subledger Entry","type":"string"},"total":{"description":"The total for the item associated with the request","format":"float","title":"Total","type":"number"}},"required":["date"],"type":"object"},"type":"array"},"notes":{"description":"The notes for the check request","title":"Notes","type":"string"},"process_id":{"description":"The id of the associated request process","title":"Process","type":"string"},"status":{"description":"The status for the request","enum":["open","processed","rejected"],"title":"Status","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"total":{"description":"The total for the request","format":"float","title":"Total","type":"number"}},"required":["business_unit_id","date","id","process_id","status","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id","total"],"type":"object"}},"components/schemas/CheckRequestProcess":{"id":"components/schemas/CheckRequestProcess","kind":"json-schema","title":"CheckRequestProcess","data":{"additionalProperties":false,"properties":{"business_unit_id":{"description":"The business unit that this process belongs to","title":"Business Unit","type":"string"},"gl_account_ids":{"description":"The GL accounts associated with the process","items":{"type":"string"},"title":"Gl Accounts","type":"array"},"id":{"description":"The unique, string identifier of this check request process","pattern":"^[\\w-|:]+$","title":"ID","type":"string"},"is_active":{"description":"Whether or not this check request process is active","title":"Is Active","type":"boolean"},"name":{"description":"The name of the check request process","title":"Name","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"template_id":{"description":"The template associated with the process","title":"Template","type":"string"}},"required":["business_unit_id","gl_account_ids","id","name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/CheckRequestSearchParameters":{"id":"components/schemas/CheckRequestSearchParameters","kind":"json-schema","title":"CheckRequestSearchParameters","data":{"additionalProperties":false,"properties":{"business_unit_id":{"title":"Business Unit","type":"string"},"date":{"title":"Date","type":"string"},"ids":{"description":"IDs to search","items":{"type":"string"},"title":"Ids","type":"array"},"process_id":{"title":"Process","type":"string"},"status":{"title":"Status","type":"string"}},"type":"object"}},"components/schemas/CheckRequestSearchResults":{"id":"components/schemas/CheckRequestSearchResults","kind":"json-schema","title":"CheckRequestSearchResults","data":{"additionalProperties":false,"properties":{"business_unit_id":{"title":"Business Unit","type":"string"},"date":{"title":"Date","type":"string"},"ids":{"description":"IDs to search","items":{"type":"string"},"title":"Ids","type":"array"},"is_active":{"title":"Is Active","type":"string"},"items":{"items":{"additionalProperties":false,"properties":{},"type":"object"},"type":"array"},"process_id":{"title":"Process","type":"string"},"status":{"title":"Status","type":"string"}},"type":"object"}},"components/schemas/CheckRequestTemplate":{"id":"components/schemas/CheckRequestTemplate","kind":"json-schema","title":"CheckRequestTemplate","data":{"additionalProperties":false,"properties":{"id":{"description":"The unique, string identifier of this check request template","pattern":"^[\\w:|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether or not this check request template is active","title":"Is Active","type":"boolean"},"name":{"description":"The name of the check request template","title":"Name","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"template":{"description":"The template","title":"Template","type":"string"}},"required":["id","name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id","template"],"type":"object"}},"components/schemas/CogsEntry":{"id":"components/schemas/CogsEntry","kind":"json-schema","title":"CogsEntry","data":{"additionalProperties":false,"properties":{"bin_id":{"description":"The bin","title":"Bin","type":"string"},"business_unit_id":{"description":"The business unit","title":"Business Unit","type":"string"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"date":{"description":"The date of the entry","format":"date-time","title":"Date","type":"string"},"fiscal_period":{"description":"The fiscal period of the entry","format":"float","maximum":23,"minimum":1,"title":"Fiscal Period","type":"number"},"fiscal_year_id":{"description":"The fiscal year of the entry","title":"Fiscal Year","type":"string"},"id":{"description":"The unique, string identifier of this cogs entry","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"inventory_adjustment_id":{"description":"A pointer to the inventory adjustment transaction that generated this entry","title":"Inventory Adjustment","type":"string"},"inventory_fulfillment_id":{"description":"A pointer to the inventory fulfillment transaction that generated this entry","title":"Inventory Fulfillment","type":"string"},"inventory_receipt_id":{"description":"A pointer to the inventory receipt transaction that generated this entry","title":"Inventory Receipt","type":"string"},"inventory_return_id":{"description":"A pointer to the inventory return transaction that generated this entry","title":"Inventory Return","type":"string"},"inventory_transaction_id":{"description":"A pointer to the inventory transaction that generated this entry","title":"Inventory Transaction","type":"string"},"notes":{"description":"Notes/description of this entry","title":"Notes","type":"string"},"order_id":{"description":"The order to which this entry is connected","title":"Order","type":"string"},"order_line_item_id":{"description":"The order line item to which this entry is connected","title":"Order Line Item","type":"string"},"parent_cogs_entry_id":{"description":"The parent COGS entry for this one","title":"Parent Cogs Entry","type":"string"},"product_id":{"description":"The product ID","title":"Product","type":"string"},"product_inventory_id":{"description":"The product inventory being supported by this entry","title":"Product Inventory","type":"string"},"product_type":{"description":"The type of the product","title":"Product Type","type":"string"},"quantity":{"description":"The quantity represented in the COGS entry","title":"Quantity","type":"integer"},"status":{"description":"The status of the entry","enum":["open","processed"],"title":"Status","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_fiscal_period_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"System field to store year + period - DO NOT USE"},"children":[]}]}]}],"title":"Sys Fiscal Period","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"total_cost":{"description":"The total cost","format":"double","title":"Total Cost","type":"number"},"type":{"description":"The type of entry","enum":["adjustment","fulfillment","receipt","return"],"title":"Type","type":"string"},"unit_cost":{"description":"The unit cost","format":"double","title":"Unit Cost","type":"number"},"warehouse_id":{"description":"The warehouse","title":"Warehouse","type":"string"}},"required":["business_unit_id","fiscal_period","fiscal_year_id","id","inventory_adjustment_id","inventory_fulfillment_id","inventory_receipt_id","inventory_return_id","inventory_transaction_id","product_id","product_inventory_id","product_type","quantity","status","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id","total_cost","type","unit_cost","warehouse_id"],"type":"object"}},"components/schemas/Credit":{"id":"components/schemas/Credit","kind":"json-schema","title":"Credit","data":{"additionalProperties":false,"properties":{"amount_available":{"format":"double","minimum":0,"title":"Amount Available","type":"number"},"amount_used":{"format":"double","title":"Amount Used","type":"number"},"base_currency_code":{"description":"The base currency for transactions business unit","maxLength":3,"minLength":3,"title":"Base Currency Code","type":"string"},"base_currency_symbol":{"description":"The base symbol for the transactions business unit","title":"Base Currency Symbol","type":"string"},"batch_id":{"description":"The batch this transaction belongs to","title":"Batch","type":"string"},"business_unit_id":{"description":"The business unit this transaction belongs to","title":"Business Unit","type":"string"},"cancellation_id":{"description":"The order cancellation tied to this transaction","title":"Cancellation","type":"string"},"confirmation_email_recipients":{"description":"Send a confirmation email to these recipients","items":{"type":"string"},"title":"Confirmation Email Recipients","type":"array"},"contact_id":{"description":"The contact that owns the payment","title":"Contact","type":"string"},"currency_code":{"description":"The currency code in use","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHF","CLP","CNY","COP","CRC","CUC","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GQE","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZM","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SYP","SZL","THB","TJS","TMT","TND","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYU","UZS","VEB","VND","VUV","WST","XAF","XCD","XDR","XOF","XPF","YER","ZAR","ZMK","ZWR"],"maxLength":3,"minLength":3,"title":"Currency Code","type":"string"},"currency_symbol":{"description":"The currency symbol","title":"Currency Symbol","type":"string"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"date":{"description":"The date of the transaction","format":"date","title":"Date","type":"string"},"exchange_rate":{"description":"The exchange rate, if applicable","format":"double","title":"Exchange Rate","type":"number"},"expense_gl_account_id":{"title":"Expense Gl Account","type":"string"},"id":{"description":"The unique, string identifier of this credit","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"liability_gl_account_id":{"title":"Liability Gl Account","type":"string"},"line_items":{"items":{"additionalProperties":false,"properties":{"credit_line_item_id":{"description":"Line item id of the credit","oneOf":[{"x-required":true}],"title":"Credit Line Item","type":"string"},"payment_line_item_id":{"description":"Line item id of the payment","oneOf":[{"x-required":true}],"title":"Payment Line Item","type":"string"},"total":{"description":"Total of the line item","format":"double","title":"Total","type":"number"},"total_in_base_currency":{"description":"The total of the transaction, in the base currency of the business unit.","format":"double","oneOf":[{"x-required":true}],"title":"Total In Base Currency","type":"number"}},"required":["total"],"type":"object"},"type":"array"},"memo":{"description":"Memo/description of the transaction","title":"Memo","type":"string"},"notes":{"description":"Notes fro the transaction","title":"Notes","type":"string"},"number":{"description":"The transaction number","title":"Number","type":"integer"},"order_id":{"description":"The order tied to this transaction","title":"Order","type":"string"},"organization_id":{"description":"The organization that owns the payment","title":"Organization","type":"string"},"owner_type":{"description":"The type of owner","enum":["contact","organization"],"title":"Owner Type","type":"string"},"payment_id":{"description":"The payment being credited","title":"Payment","type":"string"},"payment_line_item_id":{"description":"The payment line item","title":"Payment Line Item","type":"string"},"related_transactions":{"items":{"additionalProperties":false,"properties":{"amount":{"description":"The amount applied","format":"double","title":"Amount","type":"number"},"date":{"description":"The date/time of the transaction","format":"date-time","title":"Date","type":"string"},"transaction_id":{"description":"The id of the transaction","title":"Transaction","type":"string"},"transaction_line_item_id":{"description":"The line item id of the transaction","title":"Transaction Line Item","type":"string"},"transaction_number":{"description":"The number of the transaction","format":"float","title":"Transaction Number","type":"number"},"type":{"enum":["cancellation","credit","credit memo","credit usage","debit memo","invoice","payment","refund","return","shipment","write off"],"title":"Type","type":"string"}},"required":["amount","date","transaction_id","transaction_line_item_id","transaction_number"],"type":"object"},"type":"array"},"return_id":{"description":"The return tied to this transaction","title":"Return","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_owner_id":{"description":"System fields - DO NOT USE","title":"Sys Owner","type":"string"},"sys_search_composite_key":{"description":"Internal use","title":"Sys Search Composite Key","type":"string"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"total":{"description":"The transaction total","format":"double","title":"Total","type":"number"},"total_in_base_currency":{"description":"The total of the transaction, in the base currency of the business unit.","format":"double","title":"Total In Base Currency","type":"number"},"type":{"description":"The type of object being credited","enum":["legacy","manual","overpayment","payment"],"title":"Type","type":"string"},"workflow_execution_id":{"description":"The ID of the state machine execution used to create this transaction","title":"Workflow Execution","type":"string"}},"required":["amount_available","batch_id","business_unit_id","contact_id","expense_gl_account_id","id","liability_gl_account_id","number","organization_id","owner_type","payment_id","payment_line_item_id","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id","total","total_in_base_currency","type"],"type":"object"}},"components/schemas/CreditMemo":{"id":"components/schemas/CreditMemo","kind":"json-schema","title":"CreditMemo","data":{"additionalProperties":false,"properties":{"base_currency_code":{"description":"The base currency for transactions business unit","maxLength":3,"minLength":3,"title":"Base Currency Code","type":"string"},"base_currency_symbol":{"description":"The base symbol for the transactions business unit","title":"Base Currency Symbol","type":"string"},"batch_id":{"description":"The batch this transaction belongs to","title":"Batch","type":"string"},"business_unit_id":{"description":"The business unit this transaction belongs to","title":"Business Unit","type":"string"},"cancellation_id":{"description":"The order cancellation tied to this transaction","title":"Cancellation","type":"string"},"currency_code":{"description":"The currency code in use","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHF","CLP","CNY","COP","CRC","CUC","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GQE","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZM","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SYP","SZL","THB","TJS","TMT","TND","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYU","UZS","VEB","VND","VUV","WST","XAF","XCD","XDR","XOF","XPF","YER","ZAR","ZMK","ZWR"],"maxLength":3,"minLength":3,"title":"Currency Code","type":"string"},"currency_symbol":{"description":"The currency symbol","title":"Currency Symbol","type":"string"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"date":{"description":"The date of the transaction","format":"date","title":"Date","type":"string"},"exchange_rate":{"description":"The exchange rate, if applicable","format":"double","title":"Exchange Rate","type":"number"},"id":{"description":"The unique, string identifier of this credit memo","pattern":"^[\\w|:-]+$","title":"ID","type":"string"},"invoice_id":{"description":"The invoice the credit memo applies to","title":"Invoice","type":"string"},"is_from_retroactive_coupon":{"description":"If true, this was created as part of a retroactive coupon","title":"Is From Retroactive Coupon","type":"boolean"},"line_items":{"items":{"additionalProperties":false,"oneOf":[{"type":"object","properties":{"total_in_base_currency":{},"credit_memo_line_item_id":{}},"required":["total_in_base_currency","credit_memo_line_item_id"],"additionalProperties":false}],"properties":{"credit_memo_line_item_id":{"description":"The id of the credit memo line item","title":"Credit Memo Line Item","type":"string"},"description":{"description":"Descriptive information","title":"Description","type":"string"},"invoice_line_item_id":{"description":"The invoice line item being modified","title":"Invoice Line Item","type":"string"},"quantity":{"description":"Quantity","format":"float","title":"Quantity","type":"number"},"total":{"description":"Total of the line item","format":"double","title":"Total","type":"number"},"total_in_base_currency":{"description":"The total of the transaction, in the base currency of the business unit.","format":"double","title":"Total In Base Currency","type":"number"}},"required":["invoice_line_item_id","quantity","total"],"type":"object"},"minItems":1,"type":"array"},"memo":{"description":"Memo/description of the transaction","title":"Memo","type":"string"},"notes":{"description":"Notes fro the transaction","title":"Notes","type":"string"},"number":{"description":"The transaction number","title":"Number","type":"integer"},"order_id":{"description":"The order tied to this transaction","title":"Order","type":"string"},"return_id":{"description":"The return tied to this transaction","title":"Return","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_search_composite_key":{"description":"Internal use","title":"Sys Search Composite Key","type":"string"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"total":{"description":"The transaction total","format":"double","title":"Total","type":"number"},"total_in_base_currency":{"description":"The total of the transaction, in the base currency of the business unit.","format":"double","title":"Total In Base Currency","type":"number"},"workflow_execution_id":{"description":"The ID of the state machine execution used to create this transaction","title":"Workflow Execution","type":"string"}},"required":["batch_id","business_unit_id","id","invoice_id","line_items","number","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id","total","total_in_base_currency"],"type":"object"}},"components/schemas/CreditMemoSearchParameters":{"id":"components/schemas/CreditMemoSearchParameters","kind":"json-schema","title":"CreditMemoSearchParameters","data":{"additionalProperties":false,"properties":{"batch_id":{"items":{"type":"string"},"title":"Batch","type":"array"},"business_unit_id":{"description":"The business unit","title":"Business Unit","type":"string"},"date":{"items":{"type":"string"},"maxItems":2,"minItems":2,"title":"Date","type":"array"},"id":{"items":{"type":"string"},"title":"ID","type":"array"},"number":{"items":{"format":"float","type":"number"},"maxItems":2,"minItems":2,"title":"Number","type":"array"},"total":{"items":{"format":"float","type":"number"},"maxItems":2,"minItems":2,"title":"Total","type":"array"},"total_in_base_currency":{"items":{"format":"float","type":"number"},"maxItems":2,"minItems":2,"title":"Total In Base Currency","type":"array"}},"required":["business_unit_id"],"type":"object"}},"components/schemas/CreditMemoSearchResults":{"id":"components/schemas/CreditMemoSearchResults","kind":"json-schema","title":"CreditMemoSearchResults","data":{"additionalProperties":false,"properties":{"base_currency_symbol":{"title":"Base Currency Symbol","type":"string"},"batch_id":{"title":"Batch","type":"string"},"business_unit_id":{"description":"The business unit","title":"Business Unit","type":"string"},"currency_symbol":{"title":"Currency Symbol","type":"string"},"date":{"title":"Date","type":"string"},"id":{"title":"ID","type":"string"},"number":{"format":"float","title":"Number","type":"number"},"total":{"format":"float","title":"Total","type":"number"},"total_in_base_currency":{"format":"float","title":"Total In Base Currency","type":"number"}},"required":["business_unit_id"],"type":"object"}},"components/schemas/CreditSearchParameters":{"id":"components/schemas/CreditSearchParameters","kind":"json-schema","title":"CreditSearchParameters","data":{"additionalProperties":false,"properties":{"batch_id":{"items":{"type":"string"},"title":"Batch","type":"array"},"business_unit_id":{"description":"The business unit","title":"Business Unit","type":"string"},"date":{"items":{"type":"string"},"maxItems":2,"minItems":2,"title":"Date","type":"array"},"id":{"items":{"type":"string"},"title":"ID","type":"array"},"number":{"items":{"format":"float","type":"number"},"maxItems":2,"minItems":2,"title":"Number","type":"array"},"total":{"items":{"format":"float","type":"number"},"maxItems":2,"minItems":2,"title":"Total","type":"array"},"total_in_base_currency":{"items":{"format":"float","type":"number"},"maxItems":2,"minItems":2,"title":"Total In Base Currency","type":"array"}},"required":["business_unit_id"],"type":"object"}},"components/schemas/CreditSearchResults":{"id":"components/schemas/CreditSearchResults","kind":"json-schema","title":"CreditSearchResults","data":{"additionalProperties":false,"properties":{"base_currency_symbol":{"title":"Base Currency Symbol","type":"string"},"batch_id":{"title":"Batch","type":"string"},"business_unit_id":{"description":"The business unit","title":"Business Unit","type":"string"},"currency_symbol":{"title":"Currency Symbol","type":"string"},"date":{"title":"Date","type":"string"},"id":{"title":"ID","type":"string"},"number":{"format":"float","title":"Number","type":"number"},"total":{"format":"float","title":"Total","type":"number"},"total_in_base_currency":{"format":"float","title":"Total In Base Currency","type":"number"}},"required":["business_unit_id"],"type":"object"}},"components/schemas/CurrencyMappingPolicy":{"id":"components/schemas/CurrencyMappingPolicy","kind":"json-schema","title":"CurrencyMappingPolicy","data":{"additionalProperties":false,"properties":{"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"id":{"description":"The unique, string identifier of this currency mapping policy","pattern":"^[\\w:|-]+$","title":"ID","type":"string"},"name":{"description":"The name of the currency mapping policy","title":"Name","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"}},"required":["id","name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/CustomFieldValue":{"id":"components/schemas/CustomFieldValue","kind":"json-schema","title":"CustomFieldValue","data":{"additionalProperties":false,"properties":{"boolean_value":{"description":"The boolean value","title":"Boolean Value","type":"boolean"},"custom_field_id":{"description":"The unique identifier of the custom field","title":"Custom Field","type":"string"},"file_url_value":{"description":"The pointer to a file value","title":"File Url Value","type":"string"},"list_value":{"description":"The list value","items":{"type":"string"},"title":"List Value","type":"array"},"numeric_value":{"description":"The numeric value","format":"float","title":"Numeric Value","type":"number"},"string_value":{"description":"The string value of the custom field","title":"String Value","type":"string"},"table_value":{"description":"A list of objects (a table)","items":{"additionalProperties":false,"properties":{},"type":"object"},"type":"array"}},"type":"object"}},"components/schemas/DebitMemo":{"id":"components/schemas/DebitMemo","kind":"json-schema","title":"DebitMemo","data":{"additionalProperties":false,"properties":{"base_currency_code":{"description":"The base currency for transactions business unit","maxLength":3,"minLength":3,"title":"Base Currency Code","type":"string"},"base_currency_symbol":{"description":"The base symbol for the transactions business unit","title":"Base Currency Symbol","type":"string"},"batch_id":{"description":"The batch this transaction belongs to","title":"Batch","type":"string"},"business_unit_id":{"description":"The business unit this transaction belongs to","title":"Business Unit","type":"string"},"cancellation_id":{"description":"The order cancellation tied to this transaction","title":"Cancellation","type":"string"},"currency_code":{"description":"The currency code in use","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHF","CLP","CNY","COP","CRC","CUC","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GQE","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZM","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SYP","SZL","THB","TJS","TMT","TND","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYU","UZS","VEB","VND","VUV","WST","XAF","XCD","XDR","XOF","XPF","YER","ZAR","ZMK","ZWR"],"maxLength":3,"minLength":3,"title":"Currency Code","type":"string"},"currency_symbol":{"description":"The currency symbol","title":"Currency Symbol","type":"string"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"date":{"description":"The date of the transaction","format":"date","title":"Date","type":"string"},"exchange_rate":{"description":"The exchange rate, if applicable","format":"double","title":"Exchange Rate","type":"number"},"id":{"description":"The unique, string identifier of this debit memo","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"invoice_id":{"description":"The invoice the debit memo applies to","title":"Invoice","type":"string"},"line_items":{"items":{"additionalProperties":false,"oneOf":[{"type":"object","properties":{"total_in_base_currency":{},"debit_memo_line_item_id":{}},"required":["total_in_base_currency","debit_memo_line_item_id"],"additionalProperties":false}],"properties":{"debit_memo_line_item_id":{"description":"The id of the debit memo line item","title":"Debit Memo Line Item","type":"string"},"description":{"description":"Descriptive information","title":"Description","type":"string"},"invoice_line_item_id":{"description":"The invoice line item being modified","title":"Invoice Line Item","type":"string"},"quantity":{"description":"Quantity","format":"float","title":"Quantity","type":"number"},"total":{"description":"Total of the line item","format":"double","title":"Total","type":"number"},"total_in_base_currency":{"description":"The total of the transaction, in the base currency of the business unit.","format":"double","title":"Total In Base Currency","type":"number"}},"required":["invoice_line_item_id","quantity","total"],"type":"object"},"minItems":1,"type":"array"},"memo":{"description":"Memo/description of the transaction","title":"Memo","type":"string"},"notes":{"description":"Notes fro the transaction","title":"Notes","type":"string"},"number":{"description":"The transaction number","title":"Number","type":"integer"},"order_id":{"description":"The order tied to this transaction","title":"Order","type":"string"},"return_id":{"description":"The return tied to this transaction","title":"Return","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_search_composite_key":{"description":"Internal use","title":"Sys Search Composite Key","type":"string"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"total":{"description":"The transaction total","format":"double","title":"Total","type":"number"},"total_in_base_currency":{"description":"The total of the transaction, in the base currency of the business unit.","format":"double","title":"Total In Base Currency","type":"number"},"workflow_execution_id":{"description":"The ID of the state machine execution used to create this transaction","title":"Workflow Execution","type":"string"}},"required":["batch_id","business_unit_id","id","invoice_id","line_items","number","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id","total","total_in_base_currency"],"type":"object"}},"components/schemas/DebitMemoSearchParameters":{"id":"components/schemas/DebitMemoSearchParameters","kind":"json-schema","title":"DebitMemoSearchParameters","data":{"additionalProperties":false,"properties":{"batch_id":{"items":{"type":"string"},"title":"Batch","type":"array"},"business_unit_id":{"description":"The business unit","title":"Business Unit","type":"string"},"date":{"items":{"type":"string"},"maxItems":2,"minItems":2,"title":"Date","type":"array"},"id":{"items":{"type":"string"},"title":"ID","type":"array"},"number":{"items":{"format":"float","type":"number"},"maxItems":2,"minItems":2,"title":"Number","type":"array"},"total":{"items":{"format":"float","type":"number"},"maxItems":2,"minItems":2,"title":"Total","type":"array"},"total_in_base_currency":{"items":{"format":"float","type":"number"},"maxItems":2,"minItems":2,"title":"Total In Base Currency","type":"array"}},"required":["business_unit_id"],"type":"object"}},"components/schemas/DebitMemoSearchResults":{"id":"components/schemas/DebitMemoSearchResults","kind":"json-schema","title":"DebitMemoSearchResults","data":{"additionalProperties":false,"properties":{"base_currency_symbol":{"title":"Base Currency Symbol","type":"string"},"batch_id":{"title":"Batch","type":"string"},"business_unit_id":{"description":"The business unit","title":"Business Unit","type":"string"},"currency_symbol":{"title":"Currency Symbol","type":"string"},"date":{"title":"Date","type":"string"},"id":{"title":"ID","type":"string"},"number":{"format":"float","title":"Number","type":"number"},"total":{"format":"float","title":"Total","type":"number"},"total_in_base_currency":{"format":"float","title":"Total In Base Currency","type":"number"}},"required":["business_unit_id"],"type":"object"}},"components/schemas/Department":{"id":"components/schemas/Department","kind":"json-schema","title":"Department","data":{"additionalProperties":false,"properties":{"business_unit_id":{"description":"The business unit","title":"Business Unit","type":"string"},"code":{"description":"The code for the department","title":"Code","type":"string"},"description":{"description":"Description","title":"Description","type":"string"},"display_name":{"description":"The name to display","title":"Display Name","type":"string"},"id":{"description":"The unique, string identifier of this department","pattern":"^[\\w:|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether or not this department is active","title":"Is Active","type":"boolean"},"name":{"description":"The name of the department","title":"Name","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"}},"required":["business_unit_id","code","id","name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/DependentBatchResponse":{"id":"components/schemas/DependentBatchResponse","kind":"json-schema","title":"DependentBatchResponse","data":{"additionalProperties":false,"properties":{"children":{"items":{"type":"string"},"minItems":1,"title":"Children","type":"array"}},"required":["children"],"type":"object"}},"components/schemas/DonationProduct":{"id":"components/schemas/DonationProduct","kind":"json-schema","title":"DonationProduct","data":{"additionalProperties":false,"properties":{"allow_customer_to_choose_installment_plan":{"description":"If true, the customer can choose their installment plan","title":"Allow Customer To Choose Installment Plan","type":"boolean"},"bulk_pricing_rules":{"items":{"additionalProperties":false,"properties":{"discount_amount":{"description":"The percentage/flat rate","format":"float","minimum":0,"title":"Discount Amount","type":"number"},"discount_type":{"description":"The type of discount rule","enum":["flat rate","percentage"],"title":"Discount Type","type":"string"},"ending_range":{"description":"The ending range of the rule","minimum":0,"title":"Ending Range","type":"integer"},"starting_range":{"description":"The starting range of the rule","minimum":0,"title":"Starting Range","type":"integer"}},"required":["discount_amount","discount_type"],"type":"object"},"minItems":1,"type":"array"},"bundled_products":{"items":{"additionalProperties":false,"properties":{"member_price":{"description":"The member price","format":"double","title":"Member Price","type":"number"},"price":{"description":"The price to bundle","format":"double","title":"Price","type":"number"},"product_id":{"description":"The product ID","title":"Product","type":"string"},"product_type":{"description":"The product type","title":"Product Type","type":"string"},"quantity":{"description":"The quantity to bundle","title":"Quantity","type":"integer"},"type":{"enum":["bundled product","inline bundled product"],"title":"Type","type":"string"}},"required":["product_id","product_type","quantity","type"],"type":"object"},"minItems":1,"type":"array"},"bundled_products_inventory_handling":{"description":"Whether to track inventory for the entire bundle, or for each product separately","enum":["bundle","each product"],"title":"Bundled Products Inventory Handling","type":"string"},"business_unit_id":{"description":"The business unit of the product","title":"Business Unit","type":"string"},"cancellation_fee":{"description":"Cancellation fees associated with this product","format":"double","title":"Cancellation Fee","type":"number"},"commerce_entitlements_to_create":{"items":{"additionalProperties":false,"properties":{"expiration_date":{"format":"date-time","oneOf":[{"x-required":true}],"title":"Expiration Date","type":"string"},"expiration_type":{"enum":["none","relative date","specific date"],"title":"Expiration Type","type":"string"},"quantity":{"description":"The quantity","format":"float","title":"Quantity","type":"number"},"relative_expiration_date":{"additionalProperties":false,"description":"The date the task is due","oneOf":[{"x-required":true}],"properties":{"number":{"description":"The unit of time","format":"float","minimum":0,"oneOf":[{}],"title":"Number","type":"number"},"position":{"description":"How the unit relates to the reference date","enum":["after","before","on"],"title":"Position","type":"string"},"relative_to":{"enum":["the beginning of the month","the beginning of the quarter","the beginning of the week","the beginning of the year","the end of the month","the end of the quarter","the end of the week","the end of the year","the reference date"],"title":"Relative To","type":"string"},"unit_of_time":{"enum":["days","months","weeks","years"],"oneOf":[{}],"title":"Unit Of Time","type":"string"}},"required":["number","position","relative_to","unit_of_time"],"title":"Relative Expiration Date","type":"object"},"type_id":{"description":"The type of entitlement","title":"Type","type":"string"}},"required":["expiration_type","type_id"],"type":"object"},"type":"array"},"coupon_codes":{"items":{"additionalProperties":false,"properties":{"coupon_code_generation_process_id":{"description":"The process by which the coupons are generated","title":"Coupon Code Generation Process","type":"string"},"coupon_code_type":{"enum":["multi use","single use"],"title":"Coupon Code Type","type":"string"},"coupon_id":{"title":"Coupon","type":"string"},"coupon_type":{"title":"Coupon Type","type":"string"},"expiration_date":{"format":"date-time","oneOf":[{"x-required":true}],"title":"Expiration Date","type":"string"},"expiration_type":{"enum":["none","relative date","specific date"],"title":"Expiration Type","type":"string"},"maximum_number_of_total_uses":{"description":"The maximum number of total uses","minimum":1,"oneOf":[{"enum":[1],"x-required":true}],"title":"Maximum Number Of Total Uses","type":"integer"},"maximum_number_of_uses_per_customer":{"description":"The maximum number of total uses for a given customer","minimum":1,"oneOf":[{"enum":[1],"x-required":true}],"title":"Maximum Number Of Uses Per Customer","type":"integer"},"quantity":{"description":"The number of coupons to generate","maximum":250,"title":"Quantity","type":"integer"},"relative_expiration_date":{"additionalProperties":false,"description":"Expiration date relative to purchase","oneOf":[{"x-required":true}],"properties":{"number":{"description":"The unit of time","format":"float","minimum":0,"oneOf":[{}],"title":"Number","type":"number"},"position":{"description":"How the unit relates to the reference date","enum":["after","before","on"],"title":"Position","type":"string"},"relative_to":{"enum":["the beginning of the month","the beginning of the quarter","the beginning of the week","the beginning of the year","the end of the month","the end of the quarter","the end of the week","the end of the year","the reference date"],"title":"Relative To","type":"string"},"unit_of_time":{"enum":["days","months","weeks","years"],"oneOf":[{}],"title":"Unit Of Time","type":"string"}},"required":["number","position","relative_to","unit_of_time"],"title":"Relative Expiration Date","type":"object"},"restrict_to_contact":{"description":"If true, the code generated is restricted to the contact who made the purchase","title":"Restrict To Contact","type":"boolean"},"restrict_to_organization":{"description":"If true, the code generated is restricted to the organization made the purchase","title":"Restrict To Organization","type":"boolean"}},"required":["coupon_code_generation_process_id","coupon_code_type","coupon_id","coupon_type","quantity"],"type":"object"},"minItems":1,"type":"array"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"custom_pricing_options":{"additionalProperties":false,"properties":{"lambda_function_id":{"description":"The custom lambda function to use","title":"Lambda Function","type":"string"}},"required":["lambda_function_id"],"title":"Custom Pricing Options","type":"object"},"document_entitlements_to_create":{"items":{"additionalProperties":false,"properties":{"expiration_date":{"format":"date-time","oneOf":[{"x-required":true}],"title":"Expiration Date","type":"string"},"expiration_type":{"enum":["none","relative date","specific date"],"title":"Expiration Type","type":"string"},"file_cabinet_id":{"description":"The file cabinet","title":"File Cabinet","type":"string"},"item_id":{"description":"The item","title":"Item","type":"string"},"library_path":{"description":"The optional path that items will be mounted onto the digital library","title":"Library Path","type":"string"},"relative_expiration_date":{"additionalProperties":false,"description":"The date the task is due","oneOf":[{"x-required":true}],"properties":{"number":{"description":"The unit of time","format":"float","minimum":0,"oneOf":[{}],"title":"Number","type":"number"},"position":{"description":"How the unit relates to the reference date","enum":["after","before","on"],"title":"Position","type":"string"},"relative_to":{"enum":["the beginning of the month","the beginning of the quarter","the beginning of the week","the beginning of the year","the end of the month","the end of the quarter","the end of the week","the end of the year","the reference date"],"title":"Relative To","type":"string"},"unit_of_time":{"enum":["days","months","weeks","years"],"oneOf":[{}],"title":"Unit Of Time","type":"string"}},"required":["number","position","relative_to","unit_of_time"],"title":"Relative Expiration Date","type":"object"}},"required":["expiration_type","file_cabinet_id"],"type":"object"},"type":"array"},"enable_bulk_pricing":{"description":"Whether or not bulk pricing is enabled","title":"Enable Bulk Pricing","type":"boolean"},"enable_bundled_products":{"description":"Whether to enable bundled products","title":"Enable Bundled Products","type":"boolean"},"enable_cancellation_fees":{"description":"Whether or not cancellation fees are applicable","title":"Enable Cancellation Fees","type":"boolean"},"enable_commerce_entitlement_creation":{"description":"If set, document entitlements will be created to access folders or documents","title":"Enable Commerce Entitlement Creation","type":"boolean"},"enable_coupon_code_generation":{"description":"If true, purchasing this product will generate coupons","title":"Enable Coupon Code Generation","type":"boolean"},"enable_custom_pricing":{"description":"If set, the order engine will call out to a custom lambda function for custom/complex pricing","title":"Enable Custom Pricing","type":"boolean"},"enable_document_entitlement_creation":{"description":"If set, document entitlements will be created to access folders or documents","title":"Enable Document Entitlement Creation","type":"boolean"},"enable_product_confirmation_email":{"description":"If enabled, a custom email goes out whenever this product is ordered","title":"Enable Product Confirmation Email","type":"boolean"},"enable_purchase_limits":{"description":"If true, purchase limits are in place for this product","title":"Enable Purchase Limits","type":"boolean"},"enable_purchasing_eligibility":{"description":"If set, purchases of this merchandise are restricted","title":"Enable Purchasing Eligibility","type":"boolean"},"enable_special_prices":{"description":"Whether to enable special pricing logic","title":"Enable Special Prices","type":"boolean"},"enable_task_generation":{"description":"If set, tasks will be generated","title":"Enable Task Generation","type":"boolean"},"hide_from_portal":{"description":"If set, this product should not be shown in the portal","title":"Hide From Portal","type":"boolean"},"id":{"description":"The unique, string identifier of this miscellaneous product","pattern":"^[\\w:|-]+$","title":"ID","type":"string"},"installment_plan_options":{"items":{"additionalProperties":false,"properties":{"additional_cost":{"description":"The additional cost of the installment plan","format":"double","title":"Additional Cost","type":"number"},"installment_plan_id":{"description":"The installment plan that this product supports","title":"Installment Plan","type":"string"},"is_default":{"description":"Whether this is the default installment plan option","title":"Is Default","type":"boolean"}},"required":["installment_plan_id"],"type":"object"},"minItems":1,"type":"array"},"is_active":{"description":"Whether this product is active/used","title":"Is Active","type":"boolean"},"name":{"description":"The name of the miscellaneous product","title":"Name","type":"string"},"notes":{"description":"Notes","title":"Notes","type":"string"},"portal_options":{"additionalProperties":false,"properties":{"available_from":{"description":"The date from which this product should be available","format":"date-time","title":"Available From","type":"string"},"available_until":{"description":"The date until which this product should be available","format":"date-time","title":"Available Until","type":"string"}},"title":"Portal Options","type":"object"},"product_confirmation_email_options":{"additionalProperties":false,"properties":{"product_confirmation_email_id":{"oneOf":[{"x-required":true}],"title":"Product Confirmation Email","type":"string"},"product_specific_email":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"bcc":{"description":"Anyone that should be bcc'ed on the email","title":"Bcc","type":"string"},"body":{"description":"The email body","title":"Body","type":"string"},"cc":{"description":"Anyone that should be cc'ed on the email","title":"Cc","type":"string"},"from":{"description":"From email address","title":"From","type":"string"},"from_name":{"description":"From name","title":"From Name","type":"string"},"reply_to":{"description":"The reply to","title":"Reply To","type":"string"},"subject":{"description":"The email subject","title":"Subject","type":"string"}},"required":["body","subject"],"title":"Product Specific Email","type":"object"},"type":{"enum":["product specific","shared"],"title":"Type","type":"string"}},"title":"Product Confirmation Email Options","type":"object"},"publish_to_portal":{"description":"Whether or not this product should be available in the portal","title":"Publish To Portal","type":"boolean"},"purchase_limits":{"additionalProperties":false,"properties":{"error_message":{"description":"The error message to show","title":"Error Message","type":"string"},"maximum":{"description":"The maximum","format":"float","title":"Maximum","type":"number"},"relative_time_window":{"additionalProperties":false,"description":"the time window","oneOf":[{"x-required":true}],"properties":{"number":{"description":"The unit of time","format":"float","minimum":0,"oneOf":[{}],"title":"Number","type":"number"},"position":{"description":"How the unit relates to the reference date","enum":["after","before","on"],"title":"Position","type":"string"},"relative_to":{"enum":["the beginning of the month","the beginning of the quarter","the beginning of the week","the beginning of the year","the end of the month","the end of the quarter","the end of the week","the end of the year","the reference date"],"title":"Relative To","type":"string"},"unit_of_time":{"enum":["days","months","weeks","years"],"oneOf":[{}],"title":"Unit Of Time","type":"string"}},"required":["number","position","relative_to","unit_of_time"],"title":"Relative Time Window","type":"object"},"time_period":{"enum":["all time","sliding time window"],"title":"Time Period","type":"string"},"type":{"enum":["per customer"],"title":"Type","type":"string"}},"required":["maximum","time_period","type"],"title":"Purchase Limits","type":"object"},"purchasing_eligibility_criteria":{"title":"Purchasing Eligibility Criteria","type":"object"},"special_prices":{"items":{"additionalProperties":false,"properties":{"criteria":{"title":"Criteria","type":"object"},"enable_formula":{"description":"if set, a formula is used to calculate the price. If the formula fails, the price is used","title":"Enable Formula","type":"boolean"},"formula":{"description":"The formula evaluated using the expr-eval npm package","oneOf":[{"x-required":true}],"title":"Formula","type":"string"},"name":{"title":"Name","type":"string"},"price":{"format":"float","title":"Price","type":"number"}},"required":["criteria","price"],"type":"object"},"minItems":1,"type":"array"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"tasks_to_generate":{"items":{"additionalProperties":false,"properties":{"assignee_type":{"enum":["assignment role","queue","user"],"title":"Assignee Type","type":"string"},"assignment_role_id":{"description":"The assignment role that should receive the ask","oneOf":[{"x-required":true}],"title":"Assignment Role","type":"string"},"description":{"description":"A description","title":"Description","type":"string"},"due_date_type":{"description":"Whether there is a due date","enum":["none","relative date","specific date"],"title":"Due Date Type","type":"string"},"name":{"description":"The name of the task","title":"Name","type":"string"},"notify_assignees":{"description":"Notify assignee when the task is created","title":"Notify Assignees","type":"boolean"},"priority":{"enum":["high","low","normal","urgent"],"title":"Priority","type":"string"},"queue_id":{"description":"The queue that should be assigned the ask","oneOf":[{"x-required":true}],"title":"Queue","type":"string"},"relative_due_date":{"additionalProperties":false,"description":"The date the task is due","oneOf":[{"x-required":true}],"properties":{"number":{"description":"The unit of time","format":"float","minimum":0,"oneOf":[{}],"title":"Number","type":"number"},"position":{"description":"How the unit relates to the reference date","enum":["after","before","on"],"title":"Position","type":"string"},"relative_to":{"enum":["the beginning of the month","the beginning of the quarter","the beginning of the week","the beginning of the year","the end of the month","the end of the quarter","the end of the week","the end of the year","the reference date"],"title":"Relative To","type":"string"},"unit_of_time":{"enum":["days","months","weeks","years"],"oneOf":[{}],"title":"Unit Of Time","type":"string"}},"required":["number","position","relative_to","unit_of_time"],"title":"Relative Due Date","type":"object"},"specific_due_date":{"format":"date-time","oneOf":[{"x-required":true}],"title":"Specific Due Date","type":"string"},"type_id":{"description":"The type of task","title":"Type","type":"string"},"user_id":{"description":"The user that should be assigned the ask","oneOf":[{"x-required":true}],"title":"User","type":"string"}},"required":["assignee_type","due_date_type","name","type_id"],"type":"object"},"type":"array"},"type":{"description":"The product type","enum":["collect-donation-products"],"title":"Type","type":"string"}},"required":["bulk_pricing_rules","bundled_products","business_unit_id","coupon_codes","custom_pricing_options","id","installment_plan_options","name","product_confirmation_email_options","purchase_limits","special_prices","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/EmailTemplateSchema":{"id":"components/schemas/EmailTemplateSchema","kind":"json-schema","title":"EmailTemplateSchema","data":{"additionalProperties":false,"properties":{"email":{"additionalProperties":false,"properties":{"bcc":{"description":"Anyone that should be bcc'ed on the email","title":"Bcc","type":"string"},"body":{"description":"The email body","title":"Body","type":"string"},"cc":{"description":"Anyone that should be cc'ed on the email","title":"Cc","type":"string"},"from":{"description":"From email address","title":"From","type":"string"},"from_name":{"description":"From name","title":"From Name","type":"string"},"reply_to":{"description":"The reply to","title":"Reply To","type":"string"},"subject":{"description":"The email subject","title":"Subject","type":"string"}},"required":["body","subject"],"title":"Email","type":"object"},"template":{"title":"Template","type":"string"}},"type":"object"}},"components/schemas/ExchangeRate":{"id":"components/schemas/ExchangeRate","kind":"json-schema","title":"ExchangeRate","data":{"additionalProperties":false,"properties":{"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"id":{"description":"The currency code","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHF","CLP","CNY","COP","CRC","CUC","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GQE","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZM","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SYP","SZL","THB","TJS","TMT","TND","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYU","UZS","VEB","VND","VUV","WST","XAF","XCD","XDR","XOF","XPF","YER","ZAR","ZMK","ZWR"],"title":"ID","type":"string"},"notes":{"description":"Any notes","title":"Notes","type":"string"},"rates":{"items":{"additionalProperties":false,"properties":{"currency_code":{"description":"The currency","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHF","CLP","CNY","COP","CRC","CUC","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GQE","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZM","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SYP","SZL","THB","TJS","TMT","TND","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYU","UZS","VEB","VND","VUV","WST","XAF","XCD","XDR","XOF","XPF","YER","ZAR","ZMK","ZWR"],"title":"Currency Code","type":"string"},"exchange_rate":{"description":"The exchange rate","format":"double","title":"Exchange Rate","type":"number"}},"required":["currency_code","exchange_rate"],"type":"object"},"minItems":1,"type":"array"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"}},"required":["rates","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/ExternalPayment":{"id":"components/schemas/ExternalPayment","kind":"json-schema","title":"ExternalPayment","data":{"additionalProperties":false,"properties":{"contact_id":{"title":"Contact","type":"string"},"credit_card_type":{"title":"Credit Card Type","type":"string"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"date":{"description":"The date of the transaction","title":"Date","type":"string"},"description":{"description":"Description","title":"Description","type":"string"},"id":{"description":"The unique, string identifier of this external payment","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"line_items":{"items":{"additionalProperties":false,"properties":{"description":{"description":"Description","title":"Description","type":"string"},"quantity":{"description":"The quantity of the thing being paid for","format":"float","title":"Quantity","type":"number"},"total":{"description":"The total","format":"double","title":"Total","type":"number"},"unit_price":{"description":"The amount","format":"double","title":"Unit Price","type":"number"}},"type":"object"},"type":"array"},"notes":{"title":"Notes","type":"string"},"number":{"format":"float","title":"Number","type":"number"},"organization_id":{"title":"Organization","type":"string"},"payee":{"title":"Payee","type":"string"},"payment_method":{"title":"Payment Method","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"total":{"description":"The amount of the transaction","format":"double","title":"Total","type":"number"},"transaction_id":{"title":"Transaction","type":"string"}},"required":["id","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id","total"],"type":"object"}},"components/schemas/FiscalYear":{"id":"components/schemas/FiscalYear","kind":"json-schema","title":"FiscalYear","data":{"additionalProperties":false,"properties":{"business_unit_id":{"description":"The business unit that this fiscal year belongs to","title":"Business Unit","type":"string"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"end_date":{"description":"End date of the fiscal year","format":"date","title":"End Date","type":"string"},"id":{"description":"The unique, string identifier of this fiscal year","pattern":"^[\\w-:]+$","title":"ID","type":"string"},"is_partial":{"description":"If true, this is a partial fiscal year and does not have 12 periods","title":"Is Partial","type":"boolean"},"name":{"description":"The name of the fiscal year","title":"Name","type":"string"},"notes":{"description":"Any notes","title":"Notes","type":"string"},"periods":{"items":{"additionalProperties":false,"properties":{"closing_workflow_id":{"description":"The workflow ID of the step function that last closed this period","title":"Closing Workflow","type":"string"},"end_date":{"description":"End date of the fiscal period","format":"date","title":"End Date","type":"string"},"name":{"description":"Name of the fiscal period","title":"Name","type":"string"},"number":{"description":"The fiscal period number","format":"float","maximum":23,"minimum":1,"title":"Number","type":"number"},"reopening_workflow_id":{"description":"The workflow ID of the step function that last reopened this period","title":"Reopening Workflow","type":"string"},"start_date":{"description":"Start date of the fiscal period","format":"date","title":"Start Date","type":"string"},"status":{"description":"The status of the fiscal period","enum":["closed","closing","open"],"title":"Status","type":"string"}},"required":["end_date","name","number","start_date","status"],"type":"object"},"minItems":1,"type":"array"},"start_date":{"description":"Start date of the fiscal year","format":"date","title":"Start Date","type":"string"},"status":{"description":"The status of the fiscal year","enum":["closed","closing","open"],"title":"Status","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"}},"required":["business_unit_id","end_date","id","name","start_date","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/FiscalYearAndPeriod":{"id":"components/schemas/FiscalYearAndPeriod","kind":"json-schema","title":"FiscalYearAndPeriod","data":{"additionalProperties":false,"properties":{"fiscal_period":{"format":"float","title":"Fiscal Period","type":"number"},"fiscal_year":{"additionalProperties":false,"properties":{"business_unit_id":{"description":"The business unit that this fiscal year belongs to","title":"Business Unit","type":"string"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"end_date":{"description":"End date of the fiscal year","format":"date","title":"End Date","type":"string"},"id":{"description":"The unique, string identifier of this fiscal year","pattern":"^[\\w-:]+$","title":"ID","type":"string"},"is_partial":{"description":"If true, this is a partial fiscal year and does not have 12 periods","title":"Is Partial","type":"boolean"},"name":{"description":"The name of the fiscal year","title":"Name","type":"string"},"notes":{"description":"Any notes","title":"Notes","type":"string"},"periods":{"items":{"additionalProperties":false,"properties":{"closing_workflow_id":{"description":"The workflow ID of the step function that last closed this period","title":"Closing Workflow","type":"string"},"end_date":{"description":"End date of the fiscal period","format":"date","title":"End Date","type":"string"},"name":{"description":"Name of the fiscal period","title":"Name","type":"string"},"number":{"description":"The fiscal period number","format":"float","maximum":23,"minimum":1,"title":"Number","type":"number"},"reopening_workflow_id":{"description":"The workflow ID of the step function that last reopened this period","title":"Reopening Workflow","type":"string"},"start_date":{"description":"Start date of the fiscal period","format":"date","title":"Start Date","type":"string"},"status":{"description":"The status of the fiscal period","enum":["closed","closing","open"],"title":"Status","type":"string"}},"required":["end_date","name","number","start_date","status"],"type":"object"},"minItems":1,"type":"array"},"start_date":{"description":"Start date of the fiscal year","format":"date","title":"Start Date","type":"string"},"status":{"description":"The status of the fiscal year","enum":["closed","closing","open"],"title":"Status","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","oneOf":[{"x-required":true}],"title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","oneOf":[{"x-required":true}],"title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","oneOf":[{"x-required":true}],"title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","oneOf":[{"x-required":true}],"title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"}},"required":["business_unit_id","end_date","id","name","start_date"],"title":"Fiscal Year","type":"object"}},"type":"object"}},"components/schemas/GatewayEntity":{"id":"components/schemas/GatewayEntity","kind":"json-schema","title":"GatewayEntity","data":{"additionalProperties":false,"properties":{"amount":{"format":"float","title":"Amount","type":"number"},"collection":{"title":"Collection","type":"string"},"created":{"title":"Created","type":"string"},"currency":{"title":"Currency","type":"string"},"description":{"title":"Description","type":"string"},"entity":{"title":"Entity","type":"string"},"finish":{"format":"float","title":"Finish","type":"number"},"for_entity":{"title":"For Entity","type":"string"},"frozen":{"format":"float","title":"Frozen","type":"number"},"id":{"title":"ID","type":"string"},"inactive":{"format":"float","title":"Inactive","type":"number"},"maximum":{"format":"float","title":"Maximum","type":"number"},"modified":{"title":"Modified","type":"string"},"name":{"title":"Name","type":"string"},"org":{"title":"Org","type":"string"},"schedule":{"format":"float","title":"Schedule","type":"number"},"scheduleFactor":{"format":"float","title":"Schedulefactor","type":"number"},"start":{"format":"float","title":"Start","type":"number"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"txn_fee":{"format":"float","title":"Txn Fee","type":"number"},"type":{"format":"float","title":"Type","type":"number"},"um":{"format":"float","title":"Um","type":"number"}},"required":["sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/GatewayEntry":{"id":"components/schemas/GatewayEntry","kind":"json-schema","title":"GatewayEntry","data":{"additionalProperties":false,"properties":{"amount":{"format":"float","title":"Amount","type":"number"},"chargeback":{"title":"Chargeback","type":"string"},"created":{"format":"date-time","title":"Created","type":"string"},"creator":{"title":"Creator","type":"string"},"description":{"title":"Description","type":"string"},"disbursement":{"title":"Disbursement","type":"string"},"entity":{"title":"Entity","type":"string"},"event":{"format":"float","title":"Event","type":"number"},"event_id":{"title":"Event","type":"string"},"fee":{"additionalProperties":false,"properties":{"amount":{"format":"float","title":"Amount","type":"number"},"id":{"title":"ID","type":"string"},"inactive":{"format":"float","title":"Inactive","type":"number"},"modifier":{"title":"Modifier","type":"string"},"name":{"title":"Name","type":"string"},"txn_fee":{"format":"float","title":"Txn Fee","type":"number"},"type":{"format":"float","title":"Type","type":"number"},"um":{"format":"float","title":"Um","type":"number"}},"title":"Fee","type":"object"},"from_entity":{"title":"From Entity","type":"string"},"fund":{"title":"Fund","type":"string"},"id":{"title":"ID","type":"string"},"is_fee":{"format":"float","title":"Is Fee","type":"number"},"modified":{"format":"date-time","title":"Modified","type":"string"},"modifier":{"title":"Modifier","type":"string"},"opposing_entry":{"title":"Opposing Entry","type":"string"},"original_currency":{"title":"Original Currency","type":"string"},"original_event":{"format":"float","title":"Original Event","type":"number"},"original_event_id":{"title":"Original Event","type":"string"},"payrix_account_id":{"title":"Payrix Account","type":"string"},"pending_entry":{"title":"Pending Entry","type":"string"},"pending_entry_created":{"format":"date-time","title":"Pending Entry Created","type":"string"},"refund":{"title":"Refund","type":"string"},"settlement":{"title":"Settlement","type":"string"},"statement":{"title":"Statement","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"txn":{"title":"Txn","type":"string"}},"required":["sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/GatewayFee":{"id":"components/schemas/GatewayFee","kind":"json-schema","title":"GatewayFee","data":{"additionalProperties":false,"properties":{"amount":{"format":"float","title":"Amount","type":"number"},"collection":{"title":"Collection","type":"string"},"created":{"title":"Created","type":"string"},"currency":{"title":"Currency","type":"string"},"description":{"title":"Description","type":"string"},"entity":{"title":"Entity","type":"string"},"finish":{"format":"float","title":"Finish","type":"number"},"for_entity":{"title":"For Entity","type":"string"},"frozen":{"format":"float","title":"Frozen","type":"number"},"id":{"title":"ID","type":"string"},"inactive":{"format":"float","title":"Inactive","type":"number"},"maximum":{"format":"float","title":"Maximum","type":"number"},"modified":{"title":"Modified","type":"string"},"name":{"title":"Name","type":"string"},"org":{"title":"Org","type":"string"},"schedule":{"format":"float","title":"Schedule","type":"number"},"scheduleFactor":{"format":"float","title":"Schedulefactor","type":"number"},"start":{"format":"float","title":"Start","type":"number"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"txn_fee":{"format":"float","title":"Txn Fee","type":"number"},"type":{"format":"float","title":"Type","type":"number"},"um":{"format":"float","title":"Um","type":"number"}},"required":["sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/GlAccount":{"id":"components/schemas/GlAccount","kind":"json-schema","title":"GlAccount","data":{"additionalProperties":false,"properties":{"business_unit_id":{"description":"The business unit that this account belongs to","title":"Business Unit","type":"string"},"code":{"description":"The G/L code","title":"Code","type":"string"},"currency_code":{"description":"The currency code","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHF","CLP","CNY","COP","CRC","CUC","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GQE","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZM","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SYP","SZL","THB","TJS","TMT","TND","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYU","UZS","VEB","VND","VUV","WST","XAF","XCD","XDR","XOF","XPF","YER","ZAR","ZMK","ZWR"],"maxLength":3,"minLength":3,"title":"Currency Code","type":"string"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"description":{"description":"The description of the gl account","title":"Description","type":"string"},"display_name":{"description":"The name to display","title":"Display Name","type":"string"},"id":{"description":"The unique, string identifier of this gl account","pattern":"^[\\w\\-_\\s,&@\\.\\\\\\/]+$","title":"ID","type":"string"},"is_active":{"description":"Whether or not this account is active and should appear","title":"Is Active","type":"boolean"},"name":{"description":"The name of the account","title":"Name","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"type":{"enum":["accounts payable","accounts receivable","cash","cost of sales","equity","equity - retained earnings","expenses","fixed assets","income","inventory","long term liabilities","other assets","other current assets","other current liabilities"],"title":"Type","type":"string"}},"required":["business_unit_id","code","currency_code","id","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/InstallmentPlan":{"id":"components/schemas/InstallmentPlan","kind":"json-schema","title":"InstallmentPlan","data":{"additionalProperties":false,"properties":{"amount_due_up_front":{"description":"The amount to charge up front in the installment plan","format":"double","title":"Amount Due Up Front","type":"number"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"description":{"description":"Description of the plan","title":"Description","type":"string"},"exact_dates":{"items":{"additionalProperties":false,"properties":{"date":{"description":"For exact date schedules, the exact date","format":"date","title":"Date","type":"string"},"percentage_to_charge":{"description":"The amount to charge","format":"double","title":"Percentage To Charge","type":"number"}},"required":["date","percentage_to_charge"],"type":"object"},"maxItems":100,"minItems":1,"type":"array"},"fixed_installments":{"additionalProperties":false,"properties":{"installment_schedule":{"description":"A cron expression laying out the billing schedule","title":"Installment Schedule","type":"string"},"number_of_installments":{"description":"The number of installments to charge","maximum":1000,"minimum":1,"title":"Number Of Installments","type":"integer"}},"required":["installment_schedule","number_of_installments"],"title":"Fixed Installments","type":"object"},"id":{"description":"The unique, string identifier of this installment plan","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether or not the installment plan is active","title":"Is Active","type":"boolean"},"name":{"description":"The name of the installment plan","title":"Name","type":"string"},"percentage_due_up_front":{"description":"The percentage to charge up front in the installment plan","format":"double","title":"Percentage Due Up Front","type":"number"},"relative_dates":{"items":{"additionalProperties":false,"properties":{"percentage_to_charge":{"description":"The amount to charge","format":"double","title":"Percentage To Charge","type":"number"},"time_interval":{"description":"For relative date schedules, the relative date","title":"Time Interval","type":"integer"},"time_interval_units":{"description":"For relative date schedules ,the unit for the time interval","enum":["days","months","weeks","years"],"title":"Time Interval Units","type":"string"}},"required":["percentage_to_charge","time_interval","time_interval_units"],"type":"object"},"maxItems":100,"minItems":1,"type":"array"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"type":{"enum":["exact dates","fixed installments","relative dates"],"title":"Type","type":"string"}},"required":["exact_dates","fixed_installments","id","name","relative_dates","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id","type"],"type":"object"}},"components/schemas/InstallmentSchedule":{"id":"components/schemas/InstallmentSchedule","kind":"json-schema","title":"InstallmentSchedule","data":{"additionalProperties":false,"properties":{"amount_billed":{"description":"Amount of pledge fulfilled","format":"float","title":"Amount Billed","type":"number"},"amount_outstanding":{"description":"The amount of outstanding on the pledge","format":"float","title":"Amount Outstanding","type":"number"},"billing_address":{"$ref":"#/components/schemas/Address"},"business_unit_id":{"description":"The business unit","title":"Business Unit","type":"string"},"contact_id":{"title":"Contact","type":"string"},"currency_code":{"description":"The currency this schedule should be billing","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHF","CLP","CNY","COP","CRC","CUC","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GQE","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZM","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SYP","SZL","THB","TJS","TMT","TND","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYU","UZS","VEB","VND","VUV","WST","XAF","XCD","XDR","XOF","XPF","YER","ZAR","ZMK","ZWR"],"title":"Currency Code","type":"string"},"date_cancelled":{"description":"The date the schedule was cancelled","format":"date-time","title":"Date Cancelled","type":"string"},"date_last_processed":{"description":"The last time this schedule was processed","format":"date-time","title":"Date Last Processed","type":"string"},"date_of_last_reminder":{"description":"The date that the last reminder was sent for this schedule having a declined payment","format":"date-time","title":"Date Of Last Reminder","type":"string"},"electronic_payment_info":{"additionalProperties":false,"properties":{"card_expiration":{"description":"The expiration date of the card","title":"Card Expiration","type":"string"},"card_type":{"description":"The type of card being used, or CHECK if electronic check","enum":["american express","discover","electronic check","mastercard","other","visa"],"title":"Card Type","type":"string"},"merchant_account_tokens":{"items":{"additionalProperties":false,"properties":{"merchant_account_id":{"description":"The merchant account id","title":"Merchant Account","type":"string"},"token":{"description":"The token representing the card/electronic check info","title":"Token","type":"string"}},"required":["merchant_account_id","token"],"type":"object"},"minItems":1,"type":"array"},"payment_account":{"description":"The masked payment account information","title":"Payment Account","type":"string"},"payment_origin":{"description":"Whether or not this is a saved payment method","enum":["ad hoc","saved","single token"],"title":"Payment Origin","type":"string"},"token":{"description":"For integrated payments, the single token","title":"Token","type":"string"},"type":{"description":"The type of payment","enum":["credit card","electronic check"],"title":"Type","type":"string"}},"required":["payment_origin","type"],"title":"Electronic Payment Info","type":"object"},"entries":{"items":{"additionalProperties":false,"properties":{"amount":{"description":"The amount of the entry","format":"double","title":"Amount","type":"number"},"billing_run_action_id":{"description":"The billing run action ID last associated with this entry","title":"Billing Run Action","type":"string"},"billing_run_id":{"description":"The billing run ID last associated with this entry","title":"Billing Run","type":"string"},"date":{"description":"The date of the entry","format":"date","title":"Date","type":"string"},"entry_id":{"description":"A unique entry identifier","title":"Entry","type":"string"},"installment_plan_id":{"description":"The installment plan","oneOf":[{"x-required":true}],"title":"Installment Plan","type":"string"},"invoice_id":{"description":"The invoice tied to this entry, if it has been processed","title":"Invoice","type":"string"},"line_item_description":{"description":"Description of the line item","title":"Line Item Description","type":"string"},"order_id":{"description":"The order tied to this entry, if it has been processed and is a perpetual entry","title":"Order","type":"string"},"order_line_item_id":{"description":"The order line item that created this schedule","title":"Order Line Item","type":"string"},"payment_id":{"description":"The payment tied to this entry, if it has been processed","title":"Payment","type":"string"},"perpetual_options":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"end_date":{"description":"For perpetual schedules, the date to end","title":"End Date","type":"string"},"number_of_units":{"description":"Number of units","format":"float","minimum":1,"title":"Number Of Units","type":"number"},"unit_of_time":{"enum":["months","quarters","weeks","years"],"title":"Unit Of Time","type":"string"}},"required":["number_of_units","unit_of_time"],"title":"Perpetual Options","type":"object"},"product_id":{"description":"The product ID","title":"Product","type":"string"},"product_name":{"description":"Name of the product","title":"Product Name","type":"string"},"product_type":{"description":"The product type","title":"Product Type","type":"string"},"status":{"description":"The status of the schedule entry","enum":["open","processed","processing"],"title":"Status","type":"string"},"transient_transaction_id":{"description":"The \"transient\" transaction (which may fail)","oneOf":[{"x-required":true}],"title":"Transient Transaction","type":"string"},"transient_transaction_type":{"description":"The \"transient\" transaction (which may fail)","enum":["order","payment"],"oneOf":[{"x-required":true}],"title":"Transient Transaction Type","type":"string"},"type":{"description":"The type of entry","enum":["based on installment plan","perpetual"],"title":"Type","type":"string"}},"required":["amount","date","entry_id","order_line_item_id","product_id","product_name","product_type","status"],"type":"object"},"minItems":1,"type":"array"},"error_message":{"description":"The last error message experienced by this schedule","title":"Error Message","type":"string"},"id":{"description":"The unique, string identifier of this installment schedule","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"invoice_terms_id":{"description":"The invoice terms","title":"Invoice Terms","type":"string"},"merchant_account_id":{"description":"The merchant account being used","title":"Merchant Account","type":"string"},"next_processing_date":{"description":"The date of next processing for this schedule","title":"Next Processing Date","type":"string"},"notes":{"description":"Any relevant notes","title":"Notes","type":"string"},"number":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of the plan, which should match order #"},"children":[]}]}]}],"format":"float","title":"Number","type":"number"},"order_process_id":{"description":"The process ID of the order","title":"Order Process","type":"string"},"order_type":{"description":"Order type","title":"Order Type","type":"string"},"organization_id":{"title":"Organization","type":"string"},"owner_type":{"enum":["contact","organization"],"title":"Owner Type","type":"string"},"pay_for_credit_card_processing_fees":{"description":"Whether or not we are billing for processing fees","title":"Pay For Credit Card Processing Fees","type":"boolean"},"remaining_number_of_installments":{"description":"The number of payments remaining on the pledge","format":"float","title":"Remaining Number Of Installments","type":"number"},"status":{"description":"The status of the schedule","enum":["active","cancelled","completed","error","payment declined","suspended"],"title":"Status","type":"string"},"store_id":{"description":"Store ID, if an online store","title":"Store","type":"string"},"suspended_until":{"description":"If the schedule is suspended, the date until which it is suspended","title":"Suspended Until","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"use_pro_forma_invoices":{"description":"Whether pro forma invoices should be generated","title":"Use Pro Forma Invoices","type":"boolean"}},"required":["amount_billed","amount_outstanding","business_unit_id","contact_id","currency_code","date_cancelled","date_last_processed","entries","id","order_type","organization_id","owner_type","remaining_number_of_installments","status","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/Invoice":{"id":"components/schemas/Invoice","kind":"json-schema","title":"Invoice","data":{"additionalProperties":false,"properties":{"amount_paid":{"description":"The amount paid on the invoice","format":"double","title":"Amount Paid","type":"number"},"amount_refunded":{"description":"The amount refunded on the invoice","format":"double","title":"Amount Refunded","type":"number"},"amount_written_off":{"description":"The amount written off on the invoice","format":"double","title":"Amount Written Off","type":"number"},"balance_due":{"description":"The balance due on the invoice","format":"double","title":"Balance Due","type":"number"},"base_currency_code":{"description":"The base currency for transactions business unit","maxLength":3,"minLength":3,"title":"Base Currency Code","type":"string"},"base_currency_symbol":{"description":"The base symbol for the transactions business unit","title":"Base Currency Symbol","type":"string"},"batch_id":{"description":"The batch this transaction belongs to","title":"Batch","type":"string"},"bill_to_contact_id":{"description":"The person being billed for this invoice","title":"Bill To Contact","type":"string"},"bill_to_organization_id":{"description":"The organization being billed for this invoice","title":"Bill To Organization","type":"string"},"bill_to_type":{"description":"The type of invoice","enum":["contact","organization"],"title":"Bill To Type","type":"string"},"billing_address":{"$ref":"#/components/schemas/Address"},"business_unit_id":{"description":"The business unit this transaction belongs to","title":"Business Unit","type":"string"},"cancellation_id":{"description":"The order cancellation tied to this transaction","title":"Cancellation","type":"string"},"currency_code":{"description":"The currency code in use","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHF","CLP","CNY","COP","CRC","CUC","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GQE","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZM","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SYP","SZL","THB","TJS","TMT","TND","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYU","UZS","VEB","VND","VUV","WST","XAF","XCD","XDR","XOF","XPF","YER","ZAR","ZMK","ZWR"],"maxLength":3,"minLength":3,"title":"Currency Code","type":"string"},"currency_symbol":{"description":"The currency symbol","title":"Currency Symbol","type":"string"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"custom_metadata":{"additionalProperties":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom metadata that can be used by custom order generation processes for hyper-customized order & invoice forms"},"children":[]}]}]}],"properties":{},"title":"Custom Metadata","type":"object"},"date":{"description":"The date of the transaction","format":"date","title":"Date","type":"string"},"date_due":{"description":"The date the invoice is due","format":"date","title":"Date Due","type":"string"},"exchange_rate":{"description":"The exchange rate, if applicable","format":"double","title":"Exchange Rate","type":"number"},"id":{"description":"The unique, string identifier of this invoice","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"legacy_balance_due":{"description":"The balance due from the legacy system","format":"double","title":"Legacy Balance Due","type":"number"},"line_items":{"items":{"additionalProperties":false,"properties":{"amount_paid":{"description":"Amount paid on this item","format":"double","title":"Amount Paid","type":"number"},"amount_refunded":{"description":"The amount refunded on the invoice item","format":"double","title":"Amount Refunded","type":"number"},"amount_to_pay_upon_creation":{"description":"Amount to pay when created","format":"double","title":"Amount To Pay Upon Creation","type":"number"},"amount_written_off":{"description":"The amount written off on the invoice item","format":"double","title":"Amount Written Off","type":"number"},"balance_due":{"description":"The balance due on the invoice item","format":"double","title":"Balance Due","type":"number"},"bundled_product_1":{"additionalProperties":false,"properties":{"amount":{"description":"The amount of the bundled product","format":"float","title":"Amount","type":"number"},"product_id":{"description":"The bundled product ID","title":"Product","type":"string"},"product_type":{"description":"The bundled product type","title":"Product Type","type":"string"}},"required":["amount","product_id","product_type"],"title":"Bundled Product 1","type":"object"},"bundled_product_2":{"additionalProperties":false,"properties":{"amount":{"description":"The amount of the bundled product","format":"float","title":"Amount","type":"number"},"product_id":{"description":"The bundled product ID","title":"Product","type":"string"},"product_type":{"description":"The bundled product type","title":"Product Type","type":"string"}},"required":["amount","product_id","product_type"],"title":"Bundled Product 2","type":"object"},"description":{"description":"Description of the item","title":"Description","type":"string"},"has_inline_bundled_products":{"description":"If true, this line item has inline products bundled with it","title":"Has Inline Bundled Products","type":"boolean"},"inline_bundled_products":{"items":{"additionalProperties":false,"properties":{"amount":{"description":"The amount of the bundled product","format":"float","title":"Amount","type":"number"},"product_id":{"description":"The bundled product ID","title":"Product","type":"string"},"product_type":{"description":"The bundled product type","title":"Product Type","type":"string"}},"required":["amount","product_id","product_type"],"type":"object"},"minItems":1,"oneOf":[{"x-required":true}],"type":"array"},"invoice_line_item_id":{"description":"Line item id of the invoice","title":"Invoice Line Item","type":"string"},"legacy_ar_gl_account":{"description":"The legacy G/L account imported from another system","title":"Legacy Ar Gl Account","type":"string"},"legacy_balance_due":{"description":"The balance due from the legacy system","format":"double","title":"Legacy Balance Due","type":"number"},"legacy_project":{"description":"The legacy project imported from another system","title":"Legacy Project","type":"string"},"legacy_revenue_account":{"description":"The legacy G/L account imported from another system","title":"Legacy Revenue Account","type":"string"},"optional":{"description":"Whether or not this is an \"optional\" item","title":"Optional","type":"boolean"},"order_line_item_id":{"description":"If the invoice is tied to an order, the line item its tied to","title":"Order Line Item","type":"string"},"original_total":{"description":"Invoice line item original total","format":"double","title":"Original Total","type":"number"},"original_total_in_base_currency":{"description":"Invoice line item original total (base currency)","format":"double","title":"Original Total In Base Currency","type":"number"},"primary_product_total":{"description":"The total for this line item NOT allocated to bundled products","format":"float","title":"Primary Product Total","type":"number"},"product_id":{"description":"The product on the invoice line item","title":"Product","type":"string"},"product_type":{"description":"The service that owns the type of product for this line item","title":"Product Type","type":"string"},"quantity":{"description":"Quantity of the invoice line item","format":"float","title":"Quantity","type":"number"},"related_transactions":{"items":{"additionalProperties":false,"properties":{"amount":{"description":"The amount applied","format":"double","title":"Amount","type":"number"},"date":{"description":"The date/time of the transaction","format":"date-time","title":"Date","type":"string"},"transaction_id":{"description":"The id of the transaction","title":"Transaction","type":"string"},"transaction_line_item_id":{"description":"The line item id of the transaction","title":"Transaction Line Item","type":"string"},"transaction_number":{"description":"The number of the transaction","format":"float","title":"Transaction Number","type":"number"},"type":{"enum":["cancellation","credit","credit memo","credit usage","debit memo","invoice","payment","refund","return","shipment","write off"],"title":"Type","type":"string"}},"required":["amount","date","transaction_id","transaction_line_item_id","transaction_number"],"type":"object"},"type":"array"},"status":{"description":"The status of the invoice item","enum":["cancelled","open","paid","void","written off"],"title":"Status","type":"string"},"total":{"description":"Invoice line item total","format":"double","title":"Total","type":"number"},"total_in_base_currency":{"description":"Invoice line item total","format":"double","title":"Total In Base Currency","type":"number"},"unit_price":{"description":"Unit price of the invoice line item","format":"double","title":"Unit Price","type":"number"}},"required":["product_id","product_type","quantity","total","unit_price"],"type":"object"},"minItems":1,"type":"array"},"memo":{"description":"Memo/description of the transaction","title":"Memo","type":"string"},"notes":{"description":"Notes fro the transaction","title":"Notes","type":"string"},"number":{"description":"The transaction number","title":"Number","type":"integer"},"order_id":{"description":"The order tied to this transaction","title":"Order","type":"string"},"parent_invoice_id":{"description":"A parent invoice for this invoice","title":"Parent Invoice","type":"string"},"payment_terms_id":{"description":"The invoice terms being applied to this invoice","title":"Payment Terms","type":"string"},"pro_forma":{"description":"Whether or not this is a pro forma invoice","title":"Pro Forma","type":"boolean"},"purchase_order_number":{"description":"The purchase order number","title":"Purchase Order Number","type":"string"},"regenerated_invoice_id":{"description":"For legacy invoices that needed to be regenerated, this is the ID of that generated invoice","title":"Regenerated Invoice","type":"string"},"regeneration_error":{"description":"If an error occurs during regeneration, it is logged here","title":"Regeneration Error","type":"string"},"return_id":{"description":"The return tied to this transaction","title":"Return","type":"string"},"send_email_to_billing_contact":{"description":"If true, when email is processed, an email will be sent to the billing contact","title":"Send Email To Billing Contact","type":"boolean"},"sharing_secret":{"description":"Hash to be used as salt when sharing invoices publicly, preventing users from accessing invoices unless they have been given the link explicitly","title":"Sharing Secret","type":"string"},"status":{"description":"The status of the invoice","enum":["cancelled","open","paid","void","written off"],"title":"Status","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_search_composite_key":{"description":"Internal use","title":"Sys Search Composite Key","type":"string"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"template_id":{"description":"The template this invoice is using for printing/emailing","title":"Template","type":"string"},"total":{"description":"The transaction total","format":"double","title":"Total","type":"number"},"total_in_base_currency":{"description":"The total of the transaction, in the base currency of the business unit.","format":"double","title":"Total In Base Currency","type":"number"},"type":{"description":"The type of invoice","title":"Type","type":"string"},"uses_v2_api":{"description":"This invoice was processed using the v2 sync, as opposed to legacy step functions","title":"Uses V2 Api","type":"boolean"},"workflow_execution_id":{"description":"The ID of the state machine execution used to create this transaction","title":"Workflow Execution","type":"string"}},"required":["amount_paid","amount_refunded","amount_written_off","balance_due","bill_to_contact_id","bill_to_organization_id","bill_to_type","business_unit_id","date_due","id","line_items","number","status","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id","total","total_in_base_currency"],"type":"object"}},"components/schemas/InvoicePaymentTerm":{"id":"components/schemas/InvoicePaymentTerm","kind":"json-schema","title":"InvoicePaymentTerm","data":{"additionalProperties":false,"properties":{"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"id":{"description":"The unique, string identifier of this invoice payment terms","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether or not these are active terms","title":"Is Active","type":"boolean"},"name":{"description":"The name of the invoice payment terms","title":"Name","type":"string"},"number_of_days":{"description":"Number of days that the customer has to pay the invoice","format":"float","maximum":1000,"minimum":0,"title":"Number Of Days","type":"number"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"}},"required":["id","name","number_of_days","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/InvoiceSearchParameters":{"id":"components/schemas/InvoiceSearchParameters","kind":"json-schema","title":"InvoiceSearchParameters","data":{"additionalProperties":false,"properties":{"amount_paid":{"items":{"format":"float","type":"number"},"maxItems":2,"minItems":2,"title":"Amount Paid","type":"array"},"balance_due":{"items":{"format":"float","type":"number"},"maxItems":2,"minItems":2,"title":"Balance Due","type":"array"},"batch_id":{"items":{"type":"string"},"title":"Batch","type":"array"},"bill_to_contact_id":{"title":"Bill To Contact","type":"string"},"bill_to_organization_id":{"title":"Bill To Organization","type":"string"},"bill_to_type":{"title":"Bill To Type","type":"string"},"business_unit_id":{"description":"The business unit","title":"Business Unit","type":"string"},"date":{"items":{"type":"string"},"maxItems":2,"minItems":2,"title":"Date","type":"array"},"date_due":{"items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"title":"Date Due","type":"array"},"id":{"items":{"type":"string"},"title":"ID","type":"array"},"number":{"items":{"format":"float","type":"number"},"maxItems":2,"minItems":2,"title":"Number","type":"array"},"purchase_order_number":{"items":{"type":"string"},"title":"Purchase Order Number","type":"array"},"total":{"items":{"format":"float","type":"number"},"maxItems":2,"minItems":2,"title":"Total","type":"array"},"total_in_base_currency":{"items":{"format":"float","type":"number"},"maxItems":2,"minItems":2,"title":"Total In Base Currency","type":"array"}},"required":["business_unit_id"],"type":"object"}},"components/schemas/InvoiceSearchResults":{"id":"components/schemas/InvoiceSearchResults","kind":"json-schema","title":"InvoiceSearchResults","data":{"additionalProperties":false,"properties":{"amount_paid":{"format":"float","title":"Amount Paid","type":"number"},"balance_due":{"format":"float","title":"Balance Due","type":"number"},"base_currency_symbol":{"title":"Base Currency Symbol","type":"string"},"batch_id":{"title":"Batch","type":"string"},"bill_to_contact_id":{"title":"Bill To Contact","type":"string"},"bill_to_organization_id":{"title":"Bill To Organization","type":"string"},"bill_to_type":{"title":"Bill To Type","type":"string"},"business_unit_id":{"description":"The business unit","title":"Business Unit","type":"string"},"currency_symbol":{"title":"Currency Symbol","type":"string"},"date":{"title":"Date","type":"string"},"date_due":{"title":"Date Due","type":"string"},"id":{"title":"ID","type":"string"},"memo":{"title":"Memo","type":"string"},"number":{"format":"float","title":"Number","type":"number"},"total":{"format":"float","title":"Total","type":"number"},"total_in_base_currency":{"format":"float","title":"Total In Base Currency","type":"number"}},"required":["business_unit_id"],"type":"object"}},"components/schemas/InvoiceTemplate":{"id":"components/schemas/InvoiceTemplate","kind":"json-schema","title":"InvoiceTemplate","data":{"additionalProperties":false,"properties":{"email":{"additionalProperties":false,"description":"The email to send with this template","properties":{"bcc":{"description":"Anyone that should be bcc'ed on the email","title":"Bcc","type":"string"},"body":{"description":"The email body","title":"Body","type":"string"},"cc":{"description":"Anyone that should be cc'ed on the email","title":"Cc","type":"string"},"from":{"description":"From email address","title":"From","type":"string"},"from_name":{"description":"From name","title":"From Name","type":"string"},"reply_to":{"description":"The reply to","title":"Reply To","type":"string"},"subject":{"description":"The email subject","title":"Subject","type":"string"}},"required":["body","subject"],"title":"Email","type":"object"},"id":{"description":"The unique, string identifier of this statement template","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether or not this statement template is active","title":"Is Active","type":"boolean"},"name":{"description":"The name of the statement template","title":"Name","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"template":{"description":"The template","title":"Template","type":"string"}},"required":["id","name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id","template"],"type":"object"}},"components/schemas/InvoiceType":{"id":"components/schemas/InvoiceType","kind":"json-schema","title":"InvoiceType","data":{"additionalProperties":false,"properties":{"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"id":{"description":"The unique, string identifier of this invoice type","title":"ID","type":"string"},"name":{"description":"The name of the invoice type","title":"Name","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"}},"required":["sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/LateFee":{"id":"components/schemas/LateFee","kind":"json-schema","title":"LateFee","data":{"additionalProperties":false,"properties":{"business_unit_id":{"description":"The business unit of the product","title":"Business Unit","type":"string"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"id":{"description":"The unique, string identifier of this miscellaneous product","pattern":"^[\\w:|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether this product is active/used","title":"Is Active","type":"boolean"},"name":{"description":"The name of the miscellaneous product","title":"Name","type":"string"},"notes":{"description":"Notes","title":"Notes","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"type":{"description":"The product type","enum":["collect-late-fees"],"title":"Type","type":"string"}},"required":["business_unit_id","id","name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/LateFeeRule":{"id":"components/schemas/LateFeeRule","kind":"json-schema","title":"LateFeeRule","data":{"additionalProperties":false,"properties":{"business_unit_id":{"description":"The business unit ID","title":"Business Unit","type":"string"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"fee_id":{"description":"The late fee product to use","title":"Fee","type":"string"},"flat_fee":{"description":"The flat fee to charge on the overdue balance","format":"float","title":"Flat Fee","type":"number"},"grace_period":{"description":"The grace period the customer has","format":"float","title":"Grace Period","type":"number"},"id":{"description":"The unique, string identifier of this late fee rule","title":"ID","type":"string"},"invoice_type":{"description":"The unique, string identifier of this late fee rule","enum":["advertising","all","event registration","exhibitor","gift","membership","online storefront","subscription"],"title":"Invoice Type","type":"string"},"is_active":{"description":"Whether or not this late fee rule is active","title":"Is Active","type":"boolean"},"notes":{"description":"Notes","title":"Notes","type":"string"},"percentage":{"description":"The percentage to charge on the overdue balance every month","format":"float","title":"Percentage","type":"number"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"}},"required":["business_unit_id","fee_id","invoice_type","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/LegacyImportProduct":{"id":"components/schemas/LegacyImportProduct","kind":"json-schema","title":"LegacyImportProduct","data":{"additionalProperties":false,"properties":{"allow_customer_to_choose_installment_plan":{"description":"If true, the customer can choose their installment plan","title":"Allow Customer To Choose Installment Plan","type":"boolean"},"bulk_pricing_rules":{"items":{"additionalProperties":false,"properties":{"discount_amount":{"description":"The percentage/flat rate","format":"float","minimum":0,"title":"Discount Amount","type":"number"},"discount_type":{"description":"The type of discount rule","enum":["flat rate","percentage"],"title":"Discount Type","type":"string"},"ending_range":{"description":"The ending range of the rule","minimum":0,"title":"Ending Range","type":"integer"},"starting_range":{"description":"The starting range of the rule","minimum":0,"title":"Starting Range","type":"integer"}},"required":["discount_amount","discount_type"],"type":"object"},"minItems":1,"type":"array"},"bundled_products":{"items":{"additionalProperties":false,"properties":{"member_price":{"description":"The member price","format":"double","title":"Member Price","type":"number"},"price":{"description":"The price to bundle","format":"double","title":"Price","type":"number"},"product_id":{"description":"The product ID","title":"Product","type":"string"},"product_type":{"description":"The product type","title":"Product Type","type":"string"},"quantity":{"description":"The quantity to bundle","title":"Quantity","type":"integer"},"type":{"enum":["bundled product","inline bundled product"],"title":"Type","type":"string"}},"required":["product_id","product_type","quantity","type"],"type":"object"},"minItems":1,"type":"array"},"bundled_products_inventory_handling":{"description":"Whether to track inventory for the entire bundle, or for each product separately","enum":["bundle","each product"],"title":"Bundled Products Inventory Handling","type":"string"},"business_unit_id":{"description":"The business unit of the product","title":"Business Unit","type":"string"},"cancellation_fee":{"description":"Cancellation fees associated with this product","format":"double","title":"Cancellation Fee","type":"number"},"commerce_entitlements_to_create":{"items":{"additionalProperties":false,"properties":{"expiration_date":{"format":"date-time","oneOf":[{"x-required":true}],"title":"Expiration Date","type":"string"},"expiration_type":{"enum":["none","relative date","specific date"],"title":"Expiration Type","type":"string"},"quantity":{"description":"The quantity","format":"float","title":"Quantity","type":"number"},"relative_expiration_date":{"additionalProperties":false,"description":"The date the task is due","oneOf":[{"x-required":true}],"properties":{"number":{"description":"The unit of time","format":"float","minimum":0,"oneOf":[{}],"title":"Number","type":"number"},"position":{"description":"How the unit relates to the reference date","enum":["after","before","on"],"title":"Position","type":"string"},"relative_to":{"enum":["the beginning of the month","the beginning of the quarter","the beginning of the week","the beginning of the year","the end of the month","the end of the quarter","the end of the week","the end of the year","the reference date"],"title":"Relative To","type":"string"},"unit_of_time":{"enum":["days","months","weeks","years"],"oneOf":[{}],"title":"Unit Of Time","type":"string"}},"required":["number","position","relative_to","unit_of_time"],"title":"Relative Expiration Date","type":"object"},"type_id":{"description":"The type of entitlement","title":"Type","type":"string"}},"required":["expiration_type","type_id"],"type":"object"},"type":"array"},"coupon_codes":{"items":{"additionalProperties":false,"properties":{"coupon_code_generation_process_id":{"description":"The process by which the coupons are generated","title":"Coupon Code Generation Process","type":"string"},"coupon_code_type":{"enum":["multi use","single use"],"title":"Coupon Code Type","type":"string"},"coupon_id":{"title":"Coupon","type":"string"},"coupon_type":{"title":"Coupon Type","type":"string"},"expiration_date":{"format":"date-time","oneOf":[{"x-required":true}],"title":"Expiration Date","type":"string"},"expiration_type":{"enum":["none","relative date","specific date"],"title":"Expiration Type","type":"string"},"maximum_number_of_total_uses":{"description":"The maximum number of total uses","minimum":1,"oneOf":[{"enum":[1],"x-required":true}],"title":"Maximum Number Of Total Uses","type":"integer"},"maximum_number_of_uses_per_customer":{"description":"The maximum number of total uses for a given customer","minimum":1,"oneOf":[{"enum":[1],"x-required":true}],"title":"Maximum Number Of Uses Per Customer","type":"integer"},"quantity":{"description":"The number of coupons to generate","maximum":250,"title":"Quantity","type":"integer"},"relative_expiration_date":{"additionalProperties":false,"description":"Expiration date relative to purchase","oneOf":[{"x-required":true}],"properties":{"number":{"description":"The unit of time","format":"float","minimum":0,"oneOf":[{}],"title":"Number","type":"number"},"position":{"description":"How the unit relates to the reference date","enum":["after","before","on"],"title":"Position","type":"string"},"relative_to":{"enum":["the beginning of the month","the beginning of the quarter","the beginning of the week","the beginning of the year","the end of the month","the end of the quarter","the end of the week","the end of the year","the reference date"],"title":"Relative To","type":"string"},"unit_of_time":{"enum":["days","months","weeks","years"],"oneOf":[{}],"title":"Unit Of Time","type":"string"}},"required":["number","position","relative_to","unit_of_time"],"title":"Relative Expiration Date","type":"object"},"restrict_to_contact":{"description":"If true, the code generated is restricted to the contact who made the purchase","title":"Restrict To Contact","type":"boolean"},"restrict_to_organization":{"description":"If true, the code generated is restricted to the organization made the purchase","title":"Restrict To Organization","type":"boolean"}},"required":["coupon_code_generation_process_id","coupon_code_type","coupon_id","coupon_type","quantity"],"type":"object"},"minItems":1,"type":"array"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"custom_pricing_options":{"additionalProperties":false,"properties":{"lambda_function_id":{"description":"The custom lambda function to use","title":"Lambda Function","type":"string"}},"required":["lambda_function_id"],"title":"Custom Pricing Options","type":"object"},"document_entitlements_to_create":{"items":{"additionalProperties":false,"properties":{"expiration_date":{"format":"date-time","oneOf":[{"x-required":true}],"title":"Expiration Date","type":"string"},"expiration_type":{"enum":["none","relative date","specific date"],"title":"Expiration Type","type":"string"},"file_cabinet_id":{"description":"The file cabinet","title":"File Cabinet","type":"string"},"item_id":{"description":"The item","title":"Item","type":"string"},"library_path":{"description":"The optional path that items will be mounted onto the digital library","title":"Library Path","type":"string"},"relative_expiration_date":{"additionalProperties":false,"description":"The date the task is due","oneOf":[{"x-required":true}],"properties":{"number":{"description":"The unit of time","format":"float","minimum":0,"oneOf":[{}],"title":"Number","type":"number"},"position":{"description":"How the unit relates to the reference date","enum":["after","before","on"],"title":"Position","type":"string"},"relative_to":{"enum":["the beginning of the month","the beginning of the quarter","the beginning of the week","the beginning of the year","the end of the month","the end of the quarter","the end of the week","the end of the year","the reference date"],"title":"Relative To","type":"string"},"unit_of_time":{"enum":["days","months","weeks","years"],"oneOf":[{}],"title":"Unit Of Time","type":"string"}},"required":["number","position","relative_to","unit_of_time"],"title":"Relative Expiration Date","type":"object"}},"required":["expiration_type","file_cabinet_id"],"type":"object"},"type":"array"},"enable_bulk_pricing":{"description":"Whether or not bulk pricing is enabled","title":"Enable Bulk Pricing","type":"boolean"},"enable_bundled_products":{"description":"Whether to enable bundled products","title":"Enable Bundled Products","type":"boolean"},"enable_cancellation_fees":{"description":"Whether or not cancellation fees are applicable","title":"Enable Cancellation Fees","type":"boolean"},"enable_commerce_entitlement_creation":{"description":"If set, document entitlements will be created to access folders or documents","title":"Enable Commerce Entitlement Creation","type":"boolean"},"enable_coupon_code_generation":{"description":"If true, purchasing this product will generate coupons","title":"Enable Coupon Code Generation","type":"boolean"},"enable_custom_pricing":{"description":"If set, the order engine will call out to a custom lambda function for custom/complex pricing","title":"Enable Custom Pricing","type":"boolean"},"enable_document_entitlement_creation":{"description":"If set, document entitlements will be created to access folders or documents","title":"Enable Document Entitlement Creation","type":"boolean"},"enable_product_confirmation_email":{"description":"If enabled, a custom email goes out whenever this product is ordered","title":"Enable Product Confirmation Email","type":"boolean"},"enable_purchase_limits":{"description":"If true, purchase limits are in place for this product","title":"Enable Purchase Limits","type":"boolean"},"enable_purchasing_eligibility":{"description":"If set, purchases of this merchandise are restricted","title":"Enable Purchasing Eligibility","type":"boolean"},"enable_special_prices":{"description":"Whether to enable special pricing logic","title":"Enable Special Prices","type":"boolean"},"enable_task_generation":{"description":"If set, tasks will be generated","title":"Enable Task Generation","type":"boolean"},"foreign_currency_prices":{"items":{"additionalProperties":false,"properties":{"cancellation_fee":{"description":"The cancellation fee of the product for this currency","format":"double","title":"Cancellation Fee","type":"number"},"currency_code":{"enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHF","CLP","CNY","COP","CRC","CUC","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GQE","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZM","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SYP","SZL","THB","TJS","TMT","TND","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYU","UZS","VEB","VND","VUV","WST","XAF","XCD","XDR","XOF","XPF","YER","ZAR","ZMK","ZWR"],"title":"Currency Code","type":"string"},"member_price":{"description":"The price of the product for a member","format":"double","title":"Member Price","type":"number"},"mode":{"description":"How this foreign currency should be treated","enum":["calculate price","prohibit purchase","set price"],"title":"Mode","type":"string"},"price":{"description":"The price of the product","format":"double","oneOf":[{"x-required":true}],"title":"Price","type":"number"},"restocking_fee":{"description":"The restocking fee of the product for this currency","format":"double","title":"Restocking Fee","type":"number"}},"required":["currency_code"],"type":"object"},"type":"array"},"hide_from_portal":{"description":"If set, this product should not be shown in the portal","title":"Hide From Portal","type":"boolean"},"id":{"description":"The unique, string identifier of this miscellaneous product","pattern":"^[\\w:|-]+$","title":"ID","type":"string"},"installment_plan_options":{"items":{"additionalProperties":false,"properties":{"additional_cost":{"description":"The additional cost of the installment plan","format":"double","title":"Additional Cost","type":"number"},"installment_plan_id":{"description":"The installment plan that this product supports","title":"Installment Plan","type":"string"},"is_default":{"description":"Whether this is the default installment plan option","title":"Is Default","type":"boolean"}},"required":["installment_plan_id"],"type":"object"},"minItems":1,"type":"array"},"is_active":{"description":"Whether this product is active/used","title":"Is Active","type":"boolean"},"member_price":{"description":"The price of the product for an active member","format":"double","title":"Member Price","type":"number"},"name":{"description":"The name of the miscellaneous product","title":"Name","type":"string"},"notes":{"description":"Notes","title":"Notes","type":"string"},"portal_options":{"additionalProperties":false,"properties":{"available_from":{"description":"The date from which this product should be available","format":"date-time","title":"Available From","type":"string"},"available_until":{"description":"The date until which this product should be available","format":"date-time","title":"Available Until","type":"string"}},"title":"Portal Options","type":"object"},"price":{"description":"The price of the product","format":"double","title":"Price","type":"number"},"product_confirmation_email_options":{"additionalProperties":false,"properties":{"product_confirmation_email_id":{"oneOf":[{"x-required":true}],"title":"Product Confirmation Email","type":"string"},"product_specific_email":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"bcc":{"description":"Anyone that should be bcc'ed on the email","title":"Bcc","type":"string"},"body":{"description":"The email body","title":"Body","type":"string"},"cc":{"description":"Anyone that should be cc'ed on the email","title":"Cc","type":"string"},"from":{"description":"From email address","title":"From","type":"string"},"from_name":{"description":"From name","title":"From Name","type":"string"},"reply_to":{"description":"The reply to","title":"Reply To","type":"string"},"subject":{"description":"The email subject","title":"Subject","type":"string"}},"required":["body","subject"],"title":"Product Specific Email","type":"object"},"type":{"enum":["product specific","shared"],"title":"Type","type":"string"}},"title":"Product Confirmation Email Options","type":"object"},"publish_to_portal":{"description":"Whether or not this product should be available in the portal","title":"Publish To Portal","type":"boolean"},"purchase_limits":{"additionalProperties":false,"properties":{"error_message":{"description":"The error message to show","title":"Error Message","type":"string"},"maximum":{"description":"The maximum","format":"float","title":"Maximum","type":"number"},"relative_time_window":{"additionalProperties":false,"description":"the time window","oneOf":[{"x-required":true}],"properties":{"number":{"description":"The unit of time","format":"float","minimum":0,"oneOf":[{}],"title":"Number","type":"number"},"position":{"description":"How the unit relates to the reference date","enum":["after","before","on"],"title":"Position","type":"string"},"relative_to":{"enum":["the beginning of the month","the beginning of the quarter","the beginning of the week","the beginning of the year","the end of the month","the end of the quarter","the end of the week","the end of the year","the reference date"],"title":"Relative To","type":"string"},"unit_of_time":{"enum":["days","months","weeks","years"],"oneOf":[{}],"title":"Unit Of Time","type":"string"}},"required":["number","position","relative_to","unit_of_time"],"title":"Relative Time Window","type":"object"},"time_period":{"enum":["all time","sliding time window"],"title":"Time Period","type":"string"},"type":{"enum":["per customer"],"title":"Type","type":"string"}},"required":["maximum","time_period","type"],"title":"Purchase Limits","type":"object"},"purchasing_eligibility_criteria":{"title":"Purchasing Eligibility Criteria","type":"object"},"special_prices":{"items":{"additionalProperties":false,"properties":{"criteria":{"title":"Criteria","type":"object"},"enable_formula":{"description":"if set, a formula is used to calculate the price. If the formula fails, the price is used","title":"Enable Formula","type":"boolean"},"formula":{"description":"The formula evaluated using the expr-eval npm package","oneOf":[{"x-required":true}],"title":"Formula","type":"string"},"name":{"title":"Name","type":"string"},"price":{"format":"float","title":"Price","type":"number"}},"required":["criteria","price"],"type":"object"},"minItems":1,"type":"array"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"tasks_to_generate":{"items":{"additionalProperties":false,"properties":{"assignee_type":{"enum":["assignment role","queue","user"],"title":"Assignee Type","type":"string"},"assignment_role_id":{"description":"The assignment role that should receive the ask","oneOf":[{"x-required":true}],"title":"Assignment Role","type":"string"},"description":{"description":"A description","title":"Description","type":"string"},"due_date_type":{"description":"Whether there is a due date","enum":["none","relative date","specific date"],"title":"Due Date Type","type":"string"},"name":{"description":"The name of the task","title":"Name","type":"string"},"notify_assignees":{"description":"Notify assignee when the task is created","title":"Notify Assignees","type":"boolean"},"priority":{"enum":["high","low","normal","urgent"],"title":"Priority","type":"string"},"queue_id":{"description":"The queue that should be assigned the ask","oneOf":[{"x-required":true}],"title":"Queue","type":"string"},"relative_due_date":{"additionalProperties":false,"description":"The date the task is due","oneOf":[{"x-required":true}],"properties":{"number":{"description":"The unit of time","format":"float","minimum":0,"oneOf":[{}],"title":"Number","type":"number"},"position":{"description":"How the unit relates to the reference date","enum":["after","before","on"],"title":"Position","type":"string"},"relative_to":{"enum":["the beginning of the month","the beginning of the quarter","the beginning of the week","the beginning of the year","the end of the month","the end of the quarter","the end of the week","the end of the year","the reference date"],"title":"Relative To","type":"string"},"unit_of_time":{"enum":["days","months","weeks","years"],"oneOf":[{}],"title":"Unit Of Time","type":"string"}},"required":["number","position","relative_to","unit_of_time"],"title":"Relative Due Date","type":"object"},"specific_due_date":{"format":"date-time","oneOf":[{"x-required":true}],"title":"Specific Due Date","type":"string"},"type_id":{"description":"The type of task","title":"Type","type":"string"},"user_id":{"description":"The user that should be assigned the ask","oneOf":[{"x-required":true}],"title":"User","type":"string"}},"required":["assignee_type","due_date_type","name","type_id"],"type":"object"},"type":"array"},"type":{"description":"The product type","enum":["collect-legacy-import-products"],"title":"Type","type":"string"}},"required":["bulk_pricing_rules","bundled_products","business_unit_id","coupon_codes","custom_pricing_options","id","installment_plan_options","name","price","product_confirmation_email_options","purchase_limits","special_prices","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/ListBatchesResponse":{"id":"components/schemas/ListBatchesResponse","kind":"json-schema","title":"ListBatchesResponse","data":{"properties":{"Count":{"type":"integer"},"Items":{"items":{"$ref":"#/components/schemas/Batch"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/ListBillingRunActionsResponse":{"id":"components/schemas/ListBillingRunActionsResponse","kind":"json-schema","title":"ListBillingRunActionsResponse","data":{"properties":{"Count":{"type":"integer"},"Items":{"items":{"$ref":"#/components/schemas/BillingRunAction"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/ListBillingRunsResponse":{"id":"components/schemas/ListBillingRunsResponse","kind":"json-schema","title":"ListBillingRunsResponse","data":{"properties":{"Count":{"type":"integer"},"Items":{"items":{"$ref":"#/components/schemas/BillingRun"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/ListCreditMemosResponse":{"id":"components/schemas/ListCreditMemosResponse","kind":"json-schema","title":"ListCreditMemosResponse","data":{"properties":{"Count":{"type":"integer"},"Items":{"items":{"$ref":"#/components/schemas/CreditMemo"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/ListCreditsResponse":{"id":"components/schemas/ListCreditsResponse","kind":"json-schema","title":"ListCreditsResponse","data":{"properties":{"Count":{"type":"integer"},"Items":{"items":{"$ref":"#/components/schemas/Credit"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/ListDebitMemosResponse":{"id":"components/schemas/ListDebitMemosResponse","kind":"json-schema","title":"ListDebitMemosResponse","data":{"properties":{"Count":{"type":"integer"},"Items":{"items":{"$ref":"#/components/schemas/DebitMemo"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/ListExternalPaymentsResponse":{"id":"components/schemas/ListExternalPaymentsResponse","kind":"json-schema","title":"ListExternalPaymentsResponse","data":{"properties":{"Count":{"type":"integer"},"Items":{"items":{"$ref":"#/components/schemas/ExternalPayment"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/ListInstallmentSchedulesResponse":{"id":"components/schemas/ListInstallmentSchedulesResponse","kind":"json-schema","title":"ListInstallmentSchedulesResponse","data":{"properties":{"Count":{"type":"integer"},"Items":{"items":{"$ref":"#/components/schemas/InstallmentSchedule"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/ListInvoicesResponse":{"id":"components/schemas/ListInvoicesResponse","kind":"json-schema","title":"ListInvoicesResponse","data":{"properties":{"Count":{"type":"integer"},"Items":{"items":{"$ref":"#/components/schemas/Invoice"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/ListPaymentsResponse":{"id":"components/schemas/ListPaymentsResponse","kind":"json-schema","title":"ListPaymentsResponse","data":{"properties":{"Count":{"type":"integer"},"Items":{"items":{"$ref":"#/components/schemas/Payment"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/ListRecurringBillingRunsResponse":{"id":"components/schemas/ListRecurringBillingRunsResponse","kind":"json-schema","title":"ListRecurringBillingRunsResponse","data":{"properties":{"Count":{"type":"integer"},"Items":{"items":{"$ref":"#/components/schemas/RecurringBillingRun"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/ListRefundsResponse":{"id":"components/schemas/ListRefundsResponse","kind":"json-schema","title":"ListRefundsResponse","data":{"properties":{"Count":{"type":"integer"},"Items":{"items":{"$ref":"#/components/schemas/Refund"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/ListRevenueRecognitionSchedulesResponse":{"id":"components/schemas/ListRevenueRecognitionSchedulesResponse","kind":"json-schema","title":"ListRevenueRecognitionSchedulesResponse","data":{"properties":{"Count":{"type":"integer"},"Items":{"items":{"$ref":"#/components/schemas/RevenueRecognitionSchedule"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/ListStandardQueryDefinitionsResponse":{"id":"components/schemas/ListStandardQueryDefinitionsResponse","kind":"json-schema","title":"ListStandardQueryDefinitionsResponse","data":{"items":{"$ref":"#/components/schemas/StandardQueryDefinition"},"type":"array"}},"components/schemas/ListStatementsResponse":{"id":"components/schemas/ListStatementsResponse","kind":"json-schema","title":"ListStatementsResponse","data":{"properties":{"Count":{"type":"integer"},"Items":{"items":{"$ref":"#/components/schemas/Statement"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/ListStoredPaymentMethodsResponse":{"id":"components/schemas/ListStoredPaymentMethodsResponse","kind":"json-schema","title":"ListStoredPaymentMethodsResponse","data":{"properties":{"Count":{"type":"integer"},"Items":{"items":{"$ref":"#/components/schemas/StoredPaymentMethod"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/ListSubledgerEntriesResponse":{"id":"components/schemas/ListSubledgerEntriesResponse","kind":"json-schema","title":"ListSubledgerEntriesResponse","data":{"properties":{"Count":{"type":"integer"},"Items":{"items":{"$ref":"#/components/schemas/SubledgerEntry"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/ListWriteOffsResponse":{"id":"components/schemas/ListWriteOffsResponse","kind":"json-schema","title":"ListWriteOffsResponse","data":{"properties":{"Count":{"type":"integer"},"Items":{"items":{"$ref":"#/components/schemas/WriteOff"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/MerchantAccount":{"id":"components/schemas/MerchantAccount","kind":"json-schema","title":"MerchantAccount","data":{"additionalProperties":false,"properties":{"business_unit_id":{"description":"The business unit this merchant account belongs to","title":"Business Unit","type":"string"},"currency_code":{"description":"The currency of this account","maxLength":3,"minLength":3,"title":"Currency Code","type":"string"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"debug_mode":{"description":"If set, transactions do not go through gateway","title":"Debug Mode","type":"boolean"},"description":{"description":"Notes/description about the account","title":"Description","type":"string"},"enable_legacy_payment_processor_service":{"description":"If set, then a different payment processor service/account was in place prior to a specific date. Used by refunds to ensure smooth processor migration.","title":"Enable Legacy Payment Processor Service","type":"boolean"},"enable_legacy_payment_processor_service2":{"description":"If set, then a different payment processor service/account was in place prior to a specific date. Used by refunds to ensure smooth processor migration.","title":"Enable Legacy Payment Processor Service2","type":"boolean"},"gl_account_id":{"description":"The G/L account that represents the asset of this account","title":"Gl Account","type":"string"},"id":{"description":"The unique, string identifier of this merchant account","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether or not this is active","title":"Is Active","type":"boolean"},"legacy_payment_processor_info":{"additionalProperties":false,"properties":{"cut_over_date":{"description":"The date/time at which the legacy cut over occurred","format":"date-time","title":"Cut Over Date","type":"string"},"payment_processor_account_id":{"description":"The ID of the payment processor","title":"Payment Processor Account","type":"string"},"payment_processor_service":{"description":"The integration service for the merchant account","enum":["integrations-authorize-net-accounts","integrations-blue-pay-accounts","integrations-payrix-accounts","test-accounts"],"title":"Payment Processor Service","type":"string"}},"required":["cut_over_date","payment_processor_account_id","payment_processor_service"],"title":"Legacy Payment Processor Info","type":"object"},"legacy_payment_processor_info2":{"additionalProperties":false,"properties":{"cut_over_date":{"description":"The date/time at which the legacy cut over occurred","format":"date-time","title":"Cut Over Date","type":"string"},"payment_processor_account_id":{"description":"The ID of the payment processor","title":"Payment Processor Account","type":"string"},"payment_processor_service":{"description":"The integration service for the merchant account","enum":["integrations-authorize-net-accounts","integrations-blue-pay-accounts","integrations-payrix-accounts","test-accounts"],"title":"Payment Processor Service","type":"string"}},"required":["cut_over_date","payment_processor_account_id","payment_processor_service"],"title":"Legacy Payment Processor Info2","type":"object"},"name":{"description":"The name of the merchant account","title":"Name","type":"string"},"payment_processor_account_id":{"description":"The ID of the payment processor","title":"Payment Processor Account","type":"string"},"payment_processor_service":{"description":"The integration service for the merchant account","enum":["integrations-authorize-net-accounts","integrations-blue-pay-accounts","integrations-payrix-accounts","integrations-stripe-accounts","test-accounts"],"title":"Payment Processor Service","type":"string"},"priority":{"description":"The priority/order of the merchant accounts","format":"float","title":"Priority","type":"number"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"}},"required":["business_unit_id","currency_code","gl_account_id","id","legacy_payment_processor_info","legacy_payment_processor_info2","name","payment_processor_account_id","payment_processor_service","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/MiscellaneousProduct":{"id":"components/schemas/MiscellaneousProduct","kind":"json-schema","title":"MiscellaneousProduct","data":{"additionalProperties":false,"properties":{"allow_customer_to_choose_installment_plan":{"description":"If true, the customer can choose their installment plan","title":"Allow Customer To Choose Installment Plan","type":"boolean"},"bulk_pricing_rules":{"items":{"additionalProperties":false,"properties":{"discount_amount":{"description":"The percentage/flat rate","format":"float","minimum":0,"title":"Discount Amount","type":"number"},"discount_type":{"description":"The type of discount rule","enum":["flat rate","percentage"],"title":"Discount Type","type":"string"},"ending_range":{"description":"The ending range of the rule","minimum":0,"title":"Ending Range","type":"integer"},"starting_range":{"description":"The starting range of the rule","minimum":0,"title":"Starting Range","type":"integer"}},"required":["discount_amount","discount_type"],"type":"object"},"minItems":1,"type":"array"},"bundled_products":{"items":{"additionalProperties":false,"properties":{"member_price":{"description":"The member price","format":"double","title":"Member Price","type":"number"},"price":{"description":"The price to bundle","format":"double","title":"Price","type":"number"},"product_id":{"description":"The product ID","title":"Product","type":"string"},"product_type":{"description":"The product type","title":"Product Type","type":"string"},"quantity":{"description":"The quantity to bundle","title":"Quantity","type":"integer"},"type":{"enum":["bundled product","inline bundled product"],"title":"Type","type":"string"}},"required":["product_id","product_type","quantity","type"],"type":"object"},"minItems":1,"type":"array"},"bundled_products_inventory_handling":{"description":"Whether to track inventory for the entire bundle, or for each product separately","enum":["bundle","each product"],"title":"Bundled Products Inventory Handling","type":"string"},"business_unit_id":{"description":"The business unit of the product","title":"Business Unit","type":"string"},"cancellation_fee":{"description":"Cancellation fees associated with this product","format":"double","title":"Cancellation Fee","type":"number"},"commerce_entitlements_to_create":{"items":{"additionalProperties":false,"properties":{"expiration_date":{"format":"date-time","oneOf":[{"x-required":true}],"title":"Expiration Date","type":"string"},"expiration_type":{"enum":["none","relative date","specific date"],"title":"Expiration Type","type":"string"},"quantity":{"description":"The quantity","format":"float","title":"Quantity","type":"number"},"relative_expiration_date":{"additionalProperties":false,"description":"The date the task is due","oneOf":[{"x-required":true}],"properties":{"number":{"description":"The unit of time","format":"float","minimum":0,"oneOf":[{}],"title":"Number","type":"number"},"position":{"description":"How the unit relates to the reference date","enum":["after","before","on"],"title":"Position","type":"string"},"relative_to":{"enum":["the beginning of the month","the beginning of the quarter","the beginning of the week","the beginning of the year","the end of the month","the end of the quarter","the end of the week","the end of the year","the reference date"],"title":"Relative To","type":"string"},"unit_of_time":{"enum":["days","months","weeks","years"],"oneOf":[{}],"title":"Unit Of Time","type":"string"}},"required":["number","position","relative_to","unit_of_time"],"title":"Relative Expiration Date","type":"object"},"type_id":{"description":"The type of entitlement","title":"Type","type":"string"}},"required":["expiration_type","type_id"],"type":"object"},"type":"array"},"coupon_codes":{"items":{"additionalProperties":false,"properties":{"coupon_code_generation_process_id":{"description":"The process by which the coupons are generated","title":"Coupon Code Generation Process","type":"string"},"coupon_code_type":{"enum":["multi use","single use"],"title":"Coupon Code Type","type":"string"},"coupon_id":{"title":"Coupon","type":"string"},"coupon_type":{"title":"Coupon Type","type":"string"},"expiration_date":{"format":"date-time","oneOf":[{"x-required":true}],"title":"Expiration Date","type":"string"},"expiration_type":{"enum":["none","relative date","specific date"],"title":"Expiration Type","type":"string"},"maximum_number_of_total_uses":{"description":"The maximum number of total uses","minimum":1,"oneOf":[{"enum":[1],"x-required":true}],"title":"Maximum Number Of Total Uses","type":"integer"},"maximum_number_of_uses_per_customer":{"description":"The maximum number of total uses for a given customer","minimum":1,"oneOf":[{"enum":[1],"x-required":true}],"title":"Maximum Number Of Uses Per Customer","type":"integer"},"quantity":{"description":"The number of coupons to generate","maximum":250,"title":"Quantity","type":"integer"},"relative_expiration_date":{"additionalProperties":false,"description":"Expiration date relative to purchase","oneOf":[{"x-required":true}],"properties":{"number":{"description":"The unit of time","format":"float","minimum":0,"oneOf":[{}],"title":"Number","type":"number"},"position":{"description":"How the unit relates to the reference date","enum":["after","before","on"],"title":"Position","type":"string"},"relative_to":{"enum":["the beginning of the month","the beginning of the quarter","the beginning of the week","the beginning of the year","the end of the month","the end of the quarter","the end of the week","the end of the year","the reference date"],"title":"Relative To","type":"string"},"unit_of_time":{"enum":["days","months","weeks","years"],"oneOf":[{}],"title":"Unit Of Time","type":"string"}},"required":["number","position","relative_to","unit_of_time"],"title":"Relative Expiration Date","type":"object"},"restrict_to_contact":{"description":"If true, the code generated is restricted to the contact who made the purchase","title":"Restrict To Contact","type":"boolean"},"restrict_to_organization":{"description":"If true, the code generated is restricted to the organization made the purchase","title":"Restrict To Organization","type":"boolean"}},"required":["coupon_code_generation_process_id","coupon_code_type","coupon_id","coupon_type","quantity"],"type":"object"},"minItems":1,"type":"array"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"custom_pricing_options":{"additionalProperties":false,"properties":{"lambda_function_id":{"description":"The custom lambda function to use","title":"Lambda Function","type":"string"}},"required":["lambda_function_id"],"title":"Custom Pricing Options","type":"object"},"document_entitlements_to_create":{"items":{"additionalProperties":false,"properties":{"expiration_date":{"format":"date-time","oneOf":[{"x-required":true}],"title":"Expiration Date","type":"string"},"expiration_type":{"enum":["none","relative date","specific date"],"title":"Expiration Type","type":"string"},"file_cabinet_id":{"description":"The file cabinet","title":"File Cabinet","type":"string"},"item_id":{"description":"The item","title":"Item","type":"string"},"library_path":{"description":"The optional path that items will be mounted onto the digital library","title":"Library Path","type":"string"},"relative_expiration_date":{"additionalProperties":false,"description":"The date the task is due","oneOf":[{"x-required":true}],"properties":{"number":{"description":"The unit of time","format":"float","minimum":0,"oneOf":[{}],"title":"Number","type":"number"},"position":{"description":"How the unit relates to the reference date","enum":["after","before","on"],"title":"Position","type":"string"},"relative_to":{"enum":["the beginning of the month","the beginning of the quarter","the beginning of the week","the beginning of the year","the end of the month","the end of the quarter","the end of the week","the end of the year","the reference date"],"title":"Relative To","type":"string"},"unit_of_time":{"enum":["days","months","weeks","years"],"oneOf":[{}],"title":"Unit Of Time","type":"string"}},"required":["number","position","relative_to","unit_of_time"],"title":"Relative Expiration Date","type":"object"}},"required":["expiration_type","file_cabinet_id"],"type":"object"},"type":"array"},"enable_bulk_pricing":{"description":"Whether or not bulk pricing is enabled","title":"Enable Bulk Pricing","type":"boolean"},"enable_bundled_products":{"description":"Whether to enable bundled products","title":"Enable Bundled Products","type":"boolean"},"enable_cancellation_fees":{"description":"Whether or not cancellation fees are applicable","title":"Enable Cancellation Fees","type":"boolean"},"enable_commerce_entitlement_creation":{"description":"If set, document entitlements will be created to access folders or documents","title":"Enable Commerce Entitlement Creation","type":"boolean"},"enable_coupon_code_generation":{"description":"If true, purchasing this product will generate coupons","title":"Enable Coupon Code Generation","type":"boolean"},"enable_custom_pricing":{"description":"If set, the order engine will call out to a custom lambda function for custom/complex pricing","title":"Enable Custom Pricing","type":"boolean"},"enable_document_entitlement_creation":{"description":"If set, document entitlements will be created to access folders or documents","title":"Enable Document Entitlement Creation","type":"boolean"},"enable_product_confirmation_email":{"description":"If enabled, a custom email goes out whenever this product is ordered","title":"Enable Product Confirmation Email","type":"boolean"},"enable_purchase_limits":{"description":"If true, purchase limits are in place for this product","title":"Enable Purchase Limits","type":"boolean"},"enable_purchasing_eligibility":{"description":"If set, purchases of this merchandise are restricted","title":"Enable Purchasing Eligibility","type":"boolean"},"enable_special_prices":{"description":"Whether to enable special pricing logic","title":"Enable Special Prices","type":"boolean"},"enable_task_generation":{"description":"If set, tasks will be generated","title":"Enable Task Generation","type":"boolean"},"foreign_currency_prices":{"items":{"additionalProperties":false,"properties":{"cancellation_fee":{"description":"The cancellation fee of the product for this currency","format":"double","title":"Cancellation Fee","type":"number"},"currency_code":{"enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHF","CLP","CNY","COP","CRC","CUC","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GQE","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZM","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SYP","SZL","THB","TJS","TMT","TND","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYU","UZS","VEB","VND","VUV","WST","XAF","XCD","XDR","XOF","XPF","YER","ZAR","ZMK","ZWR"],"title":"Currency Code","type":"string"},"member_price":{"description":"The price of the product for a member","format":"double","title":"Member Price","type":"number"},"mode":{"description":"How this foreign currency should be treated","enum":["calculate price","prohibit purchase","set price"],"title":"Mode","type":"string"},"price":{"description":"The price of the product","format":"double","oneOf":[{"x-required":true}],"title":"Price","type":"number"},"restocking_fee":{"description":"The restocking fee of the product for this currency","format":"double","title":"Restocking Fee","type":"number"}},"required":["currency_code"],"type":"object"},"type":"array"},"hide_from_portal":{"description":"If set, this product should not be shown in the portal","title":"Hide From Portal","type":"boolean"},"id":{"description":"The unique, string identifier of this miscellaneous product","pattern":"^[\\w:|-]+$","title":"ID","type":"string"},"installment_plan_options":{"items":{"additionalProperties":false,"properties":{"additional_cost":{"description":"The additional cost of the installment plan","format":"double","title":"Additional Cost","type":"number"},"installment_plan_id":{"description":"The installment plan that this product supports","title":"Installment Plan","type":"string"},"is_default":{"description":"Whether this is the default installment plan option","title":"Is Default","type":"boolean"}},"required":["installment_plan_id"],"type":"object"},"minItems":1,"type":"array"},"is_active":{"description":"Whether this product is active/used","title":"Is Active","type":"boolean"},"member_price":{"description":"The price of the product for an active member","format":"double","title":"Member Price","type":"number"},"name":{"description":"The name of the miscellaneous product","title":"Name","type":"string"},"notes":{"description":"Notes","title":"Notes","type":"string"},"portal_options":{"additionalProperties":false,"properties":{"available_from":{"description":"The date from which this product should be available","format":"date-time","title":"Available From","type":"string"},"available_until":{"description":"The date until which this product should be available","format":"date-time","title":"Available Until","type":"string"}},"title":"Portal Options","type":"object"},"price":{"description":"The price of the product","format":"double","title":"Price","type":"number"},"product_confirmation_email_options":{"additionalProperties":false,"properties":{"product_confirmation_email_id":{"oneOf":[{"x-required":true}],"title":"Product Confirmation Email","type":"string"},"product_specific_email":{"additionalProperties":false,"oneOf":[{"x-required":true}],"properties":{"bcc":{"description":"Anyone that should be bcc'ed on the email","title":"Bcc","type":"string"},"body":{"description":"The email body","title":"Body","type":"string"},"cc":{"description":"Anyone that should be cc'ed on the email","title":"Cc","type":"string"},"from":{"description":"From email address","title":"From","type":"string"},"from_name":{"description":"From name","title":"From Name","type":"string"},"reply_to":{"description":"The reply to","title":"Reply To","type":"string"},"subject":{"description":"The email subject","title":"Subject","type":"string"}},"required":["body","subject"],"title":"Product Specific Email","type":"object"},"type":{"enum":["product specific","shared"],"title":"Type","type":"string"}},"title":"Product Confirmation Email Options","type":"object"},"publish_to_portal":{"description":"Whether or not this product should be available in the portal","title":"Publish To Portal","type":"boolean"},"purchase_limits":{"additionalProperties":false,"properties":{"error_message":{"description":"The error message to show","title":"Error Message","type":"string"},"maximum":{"description":"The maximum","format":"float","title":"Maximum","type":"number"},"relative_time_window":{"additionalProperties":false,"description":"the time window","oneOf":[{"x-required":true}],"properties":{"number":{"description":"The unit of time","format":"float","minimum":0,"oneOf":[{}],"title":"Number","type":"number"},"position":{"description":"How the unit relates to the reference date","enum":["after","before","on"],"title":"Position","type":"string"},"relative_to":{"enum":["the beginning of the month","the beginning of the quarter","the beginning of the week","the beginning of the year","the end of the month","the end of the quarter","the end of the week","the end of the year","the reference date"],"title":"Relative To","type":"string"},"unit_of_time":{"enum":["days","months","weeks","years"],"oneOf":[{}],"title":"Unit Of Time","type":"string"}},"required":["number","position","relative_to","unit_of_time"],"title":"Relative Time Window","type":"object"},"time_period":{"enum":["all time","sliding time window"],"title":"Time Period","type":"string"},"type":{"enum":["per customer"],"title":"Type","type":"string"}},"required":["maximum","time_period","type"],"title":"Purchase Limits","type":"object"},"purchasing_eligibility_criteria":{"title":"Purchasing Eligibility Criteria","type":"object"},"special_prices":{"items":{"additionalProperties":false,"properties":{"criteria":{"title":"Criteria","type":"object"},"enable_formula":{"description":"if set, a formula is used to calculate the price. If the formula fails, the price is used","title":"Enable Formula","type":"boolean"},"formula":{"description":"The formula evaluated using the expr-eval npm package","oneOf":[{"x-required":true}],"title":"Formula","type":"string"},"name":{"title":"Name","type":"string"},"price":{"format":"float","title":"Price","type":"number"}},"required":["criteria","price"],"type":"object"},"minItems":1,"type":"array"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"tasks_to_generate":{"items":{"additionalProperties":false,"properties":{"assignee_type":{"enum":["assignment role","queue","user"],"title":"Assignee Type","type":"string"},"assignment_role_id":{"description":"The assignment role that should receive the ask","oneOf":[{"x-required":true}],"title":"Assignment Role","type":"string"},"description":{"description":"A description","title":"Description","type":"string"},"due_date_type":{"description":"Whether there is a due date","enum":["none","relative date","specific date"],"title":"Due Date Type","type":"string"},"name":{"description":"The name of the task","title":"Name","type":"string"},"notify_assignees":{"description":"Notify assignee when the task is created","title":"Notify Assignees","type":"boolean"},"priority":{"enum":["high","low","normal","urgent"],"title":"Priority","type":"string"},"queue_id":{"description":"The queue that should be assigned the ask","oneOf":[{"x-required":true}],"title":"Queue","type":"string"},"relative_due_date":{"additionalProperties":false,"description":"The date the task is due","oneOf":[{"x-required":true}],"properties":{"number":{"description":"The unit of time","format":"float","minimum":0,"oneOf":[{}],"title":"Number","type":"number"},"position":{"description":"How the unit relates to the reference date","enum":["after","before","on"],"title":"Position","type":"string"},"relative_to":{"enum":["the beginning of the month","the beginning of the quarter","the beginning of the week","the beginning of the year","the end of the month","the end of the quarter","the end of the week","the end of the year","the reference date"],"title":"Relative To","type":"string"},"unit_of_time":{"enum":["days","months","weeks","years"],"oneOf":[{}],"title":"Unit Of Time","type":"string"}},"required":["number","position","relative_to","unit_of_time"],"title":"Relative Due Date","type":"object"},"specific_due_date":{"format":"date-time","oneOf":[{"x-required":true}],"title":"Specific Due Date","type":"string"},"type_id":{"description":"The type of task","title":"Type","type":"string"},"user_id":{"description":"The user that should be assigned the ask","oneOf":[{"x-required":true}],"title":"User","type":"string"}},"required":["assignee_type","due_date_type","name","type_id"],"type":"object"},"type":"array"},"type":{"description":"The product type","enum":["collect-miscellaneous-products"],"title":"Type","type":"string"}},"required":["bulk_pricing_rules","bundled_products","business_unit_id","coupon_codes","custom_pricing_options","id","installment_plan_options","name","price","product_confirmation_email_options","purchase_limits","special_prices","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/OpenBalance":{"id":"components/schemas/OpenBalance","kind":"json-schema","title":"OpenBalance","data":{"additionalProperties":false,"properties":{"balance":{"description":"The balance","format":"float","title":"Balance","type":"number"},"currency_code":{"description":"The currency","title":"Currency Code","type":"string"},"currency_symbol":{"description":"Currency symbol","title":"Currency Symbol","type":"string"}},"type":"object"}},"components/schemas/OwnerType":{"id":"components/schemas/OwnerType","kind":"json-schema","title":"OwnerType","data":{"enum":["contact","organization"],"type":"string"}},"components/schemas/PagedBatchSearchResults":{"id":"components/schemas/PagedBatchSearchResults","kind":"json-schema","title":"PagedBatchSearchResults","data":{"properties":{"Items":{"items":{"$ref":"#/components/schemas/BatchSearchResults"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/PagedBillingRunSearchResults":{"id":"components/schemas/PagedBillingRunSearchResults","kind":"json-schema","title":"PagedBillingRunSearchResults","data":{"properties":{"Items":{"items":{"$ref":"#/components/schemas/BillingRunSearchResults"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/PagedCheckRequestSearchResults":{"id":"components/schemas/PagedCheckRequestSearchResults","kind":"json-schema","title":"PagedCheckRequestSearchResults","data":{"properties":{"Items":{"items":{"$ref":"#/components/schemas/CheckRequestSearchResults"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/PagedCreditMemoSearchResults":{"id":"components/schemas/PagedCreditMemoSearchResults","kind":"json-schema","title":"PagedCreditMemoSearchResults","data":{"properties":{"Items":{"items":{"$ref":"#/components/schemas/CreditMemoSearchResults"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/PagedCreditSearchResults":{"id":"components/schemas/PagedCreditSearchResults","kind":"json-schema","title":"PagedCreditSearchResults","data":{"properties":{"Items":{"items":{"$ref":"#/components/schemas/CreditSearchResults"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/PagedDebitMemoSearchResults":{"id":"components/schemas/PagedDebitMemoSearchResults","kind":"json-schema","title":"PagedDebitMemoSearchResults","data":{"properties":{"Items":{"items":{"$ref":"#/components/schemas/DebitMemoSearchResults"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/PagedInvoiceSearchResults":{"id":"components/schemas/PagedInvoiceSearchResults","kind":"json-schema","title":"PagedInvoiceSearchResults","data":{"properties":{"Items":{"items":{"$ref":"#/components/schemas/InvoiceSearchResults"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/PagedPaymentSearchResults":{"id":"components/schemas/PagedPaymentSearchResults","kind":"json-schema","title":"PagedPaymentSearchResults","data":{"properties":{"Items":{"items":{"$ref":"#/components/schemas/PaymentSearchResults"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/PagedRefundSearchResults":{"id":"components/schemas/PagedRefundSearchResults","kind":"json-schema","title":"PagedRefundSearchResults","data":{"properties":{"Items":{"items":{"$ref":"#/components/schemas/RefundSearchResults"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/PagedWriteOffSearchResults":{"id":"components/schemas/PagedWriteOffSearchResults","kind":"json-schema","title":"PagedWriteOffSearchResults","data":{"properties":{"Items":{"items":{"$ref":"#/components/schemas/WriteOffSearchResults"},"type":"array"},"LastEvaluatedKey":{"type":"string"}},"type":"object"}},"components/schemas/PatchDirective":{"id":"components/schemas/PatchDirective","kind":"json-schema","title":"PatchDirective","data":{"additionalProperties":false,"properties":{"op":{"description":"The operation","enum":["add","copy","move","remove","replace","test"],"title":"Op","type":"string"},"path":{"description":"The JSON path","title":"Path","type":"string"},"value":{"title":"Value","type":"string"}},"required":["op","path"],"type":"object"}},"components/schemas/Payment":{"id":"components/schemas/Payment","kind":"json-schema","title":"Payment","data":{"additionalProperties":false,"properties":{"amount_pending_capture":{"description":"The amount of payment yet to be captured","format":"double","title":"Amount Pending Capture","type":"number"},"bank_account_id":{"description":"The bank account to use for this payment","title":"Bank Account","type":"string"},"base_currency_code":{"description":"The base currency for transactions business unit","maxLength":3,"minLength":3,"title":"Base Currency Code","type":"string"},"base_currency_symbol":{"description":"The base symbol for the transactions business unit","title":"Base Currency Symbol","type":"string"},"batch_id":{"description":"The batch this transaction belongs to","title":"Batch","type":"string"},"billing_address":{"$ref":"#/components/schemas/Address"},"billing_run_action_id":{"description":"The billing run action that created this order; we track it here only to pass it back through the billing service","title":"Billing Run Action","type":"string"},"billing_run_id":{"description":"If this is part of a billing run, the ID ","title":"Billing Run","type":"string"},"billing_run_service":{"description":"If initiated by a billing run, the relevant service","title":"Billing Run Service","type":"string"},"business_unit_id":{"description":"The business unit this transaction belongs to","title":"Business Unit","type":"string"},"cancellation_id":{"description":"The order cancellation tied to this transaction","title":"Cancellation","type":"string"},"captures":{"items":{"additionalProperties":false,"properties":{"amount_captured":{"description":"The amount captured","format":"double","title":"Amount Captured","type":"number"},"card_expiration":{"description":"The card expiration","format":"date","title":"Card Expiration","type":"string"},"card_last_digits":{"description":"The last 4 digits of the card that was processed","title":"Card Last Digits","type":"string"},"card_type":{"description":"The card type","title":"Card Type","type":"string"},"date":{"description":"date of the capture","format":"date-time","title":"Date","type":"string"},"raw_capture_info":{"description":"The raw information from the gateway","title":"Raw Capture Info","type":"string"},"transaction_id":{"description":"The transaction id of the capture","title":"Transaction","type":"string"}},"required":["amount_captured","date","transaction_id"],"type":"object"},"type":"array"},"card_expiration":{"description":"The card expiration","format":"date","title":"Card Expiration","type":"string"},"card_last_digits":{"description":"The last 4 digits of the card that was processed","title":"Card Last Digits","type":"string"},"card_type":{"description":"The card type","title":"Card Type","type":"string"},"cash_account_type":{"description":"Type of cash account to use","enum":["bank","merchant","none"],"title":"Cash Account Type","type":"string"},"contact_id":{"description":"The contact that owns the payment","title":"Contact","type":"string"},"currency_code":{"description":"The currency code in use","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHF","CLP","CNY","COP","CRC","CUC","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GQE","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZM","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SYP","SZL","THB","TJS","TMT","TND","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYU","UZS","VEB","VND","VUV","WST","XAF","XCD","XDR","XOF","XPF","YER","ZAR","ZMK","ZWR"],"maxLength":3,"minLength":3,"title":"Currency Code","type":"string"},"currency_symbol":{"description":"The currency symbol","title":"Currency Symbol","type":"string"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"date":{"description":"The date of the transaction","format":"date","title":"Date","type":"string"},"electronic_payment_info":{"additionalProperties":false,"properties":{"card_expiration":{"description":"The card expiration","format":"date","title":"Card Expiration","type":"string"},"card_type":{"description":"The type of card being used, or CHECK if electronic check","enum":["american express","discover","electronic check","mastercard","other","visa"],"title":"Card Type","type":"string"},"payment_account":{"description":"The masked payment account information","title":"Payment Account","type":"string"},"payment_origin":{"description":"Whether or not this is a saved payment method","enum":["ad hoc","saved"],"title":"Payment Origin","type":"string"},"token":{"description":"The token representing the card/electronic check info","title":"Token","type":"string"}},"required":["payment_origin","token"],"title":"Electronic Payment Info","type":"object"},"exchange_rate":{"description":"The exchange rate, if applicable","format":"double","title":"Exchange Rate","type":"number"},"id":{"description":"The unique, string identifier of this payment","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"installment_schedule_id":{"description":"If this is tied to an installment schedule","title":"Installment Schedule","type":"string"},"legacy_processor":{"description":"If true, this payment was run using the legacy processor of the merchant account","title":"Legacy Processor","type":"boolean"},"line_items":{"items":{"additionalProperties":false,"oneOf":[{"type":"object","properties":{"payment_line_item_id":{},"total_in_base_currency":{},"amount_refunded":{}},"required":["payment_line_item_id","total_in_base_currency","amount_refunded"],"additionalProperties":false}],"properties":{"amount_refunded":{"description":"The amount that was refunded","format":"double","title":"Amount Refunded","type":"number"},"bundled_product_1":{"additionalProperties":false,"properties":{"amount":{"description":"The amount of the bundled product","format":"float","title":"Amount","type":"number"},"product_id":{"description":"The bundled product ID","title":"Product","type":"string"},"product_type":{"description":"The bundled product type","title":"Product Type","type":"string"}},"required":["amount","product_id","product_type"],"title":"Bundled Product 1","type":"object"},"bundled_product_2":{"additionalProperties":false,"properties":{"amount":{"description":"The amount of the bundled product","format":"float","title":"Amount","type":"number"},"product_id":{"description":"The bundled product ID","title":"Product","type":"string"},"product_type":{"description":"The bundled product type","title":"Product Type","type":"string"}},"required":["amount","product_id","product_type"],"title":"Bundled Product 2","type":"object"},"credit_id":{"description":"ID of the credit that was generated","oneOf":[{"x-required":true}],"title":"Credit","type":"string"},"enable_auto_renewal":{"description":"If set, the host record should turn on auto renewal using this payment info","title":"Enable Auto Renewal","type":"boolean"},"invoice_currency_code":{"description":"The currency code in use","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHF","CLP","CNY","COP","CRC","CUC","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GQE","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZM","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SYP","SZL","THB","TJS","TMT","TND","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYU","UZS","VEB","VND","VUV","WST","XAF","XCD","XDR","XOF","XPF","YER","ZAR","ZMK","ZWR"],"maxLength":3,"minLength":3,"title":"Invoice Currency Code","type":"string"},"invoice_exchange_rate":{"description":"The exchange rate, if applicable","format":"float","title":"Invoice Exchange Rate","type":"number"},"invoice_id":{"description":"Id of the invoice being paid","oneOf":[{"x-required":true}],"title":"Invoice","type":"string"},"invoice_line_item_balance_due_after_payment":{"description":"Balance due on the invoice after payment was applied","format":"double","title":"Invoice Line Item Balance Due After Payment","type":"number"},"invoice_line_item_balance_due_at_the_time_of_payment":{"description":"The line item balance due at the time of payment","format":"double","title":"Invoice Line Item Balance Due At The Time Of Payment","type":"number"},"invoice_line_item_id":{"description":"Line item id of the invoice","title":"Invoice Line Item","type":"string"},"invoice_line_item_total_at_the_time_of_payment":{"description":"Invoice line item total when payment was made","format":"double","title":"Invoice Line Item Total At The Time Of Payment","type":"number"},"invoice_version_at_the_time_of_payment":{"description":"The version of the invoice object at the time of payment","format":"float","title":"Invoice Version At The Time Of Payment","type":"number"},"payment_line_item_id":{"description":"Line item id of the payment","title":"Payment Line Item","type":"string"},"primary_product_total":{"description":"When inline bundling is used, this is the total amount for the primary product","format":"float","title":"Primary Product Total","type":"number"},"product_id":{"description":"If this payment is for an invoice item, the product id","title":"Product","type":"string"},"product_type":{"description":"If this payment is for an invoice item, the product type/microservice","title":"Product Type","type":"string"},"related_transactions":{"items":{"additionalProperties":false,"properties":{"amount":{"description":"The amount applied","format":"double","title":"Amount","type":"number"},"date":{"description":"The date/time of the transaction","format":"date-time","title":"Date","type":"string"},"transaction_id":{"description":"The id of the transaction","title":"Transaction","type":"string"},"transaction_line_item_id":{"description":"The line item id of the transaction","title":"Transaction Line Item","type":"string"},"transaction_number":{"description":"The number of the transaction","format":"float","title":"Transaction Number","type":"number"},"type":{"enum":["cancellation","credit","credit memo","credit usage","debit memo","invoice","payment","refund","return","shipment","write off"],"title":"Type","type":"string"}},"required":["amount","date","transaction_id","transaction_line_item_id","transaction_number"],"type":"object"},"type":"array"},"total":{"description":"Total of the line item","format":"double","title":"Total","type":"number"},"total_in_base_currency":{"description":"The total of the transaction, in the base currency of the business unit.","format":"double","title":"Total In Base Currency","type":"number"},"total_in_invoice_currency":{"description":"The total of the transaction, in the currency of the invoice.","format":"double","title":"Total In Invoice Currency","type":"number"},"type":{"description":"Type of payment line item","enum":["credit usage","invoice","overpayment"],"title":"Type","type":"string"}},"required":["total","type"],"type":"object"},"minItems":1,"type":"array"},"memo":{"description":"Memo/description of the transaction","title":"Memo","type":"string"},"merchant_account_id":{"description":"The merchant account to use for this payment","title":"Merchant Account","type":"string"},"notes":{"description":"Notes fro the transaction","title":"Notes","type":"string"},"number":{"description":"The transaction number","title":"Number","type":"integer"},"order_id":{"description":"The order tied to this transaction","title":"Order","type":"string"},"organization_id":{"description":"The organization that owns the payment","title":"Organization","type":"string"},"owner_type":{"description":"The type of owner","enum":["contact","organization"],"title":"Owner Type","type":"string"},"payment_that_this_transaction_reverses_id":{"description":"The name of the payment that THIS payment reverses or backs out","title":"Payment That This Transaction Reverses","type":"string"},"reference_number":{"description":"A reference number to be used for the payment","title":"Reference Number","type":"string"},"return_id":{"description":"The return tied to this transaction","title":"Return","type":"string"},"send_email_confirmation":{"description":"Whether to send an email confirmation","title":"Send Email Confirmation","type":"boolean"},"send_receipt_to":{"description":"The email address(es) to send receipts","title":"Send Receipt To","type":"string"},"settlement_discrepancy":{"description":"The difference between the total in base currency and the amount actually settled","format":"float","title":"Settlement Discrepancy","type":"number"},"status":{"enum":["complete","partially refunded","refunded","reversed","void"],"title":"Status","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_search_composite_key":{"description":"Internal use","title":"Sys Search Composite Key","type":"string"},"sys_search_credit_card_type":{"description":"Internal use","title":"Sys Search Credit Card Type","type":"string"},"sys_search_transaction_id":{"description":"Internal use","title":"Sys Search Transaction","type":"string"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"total":{"description":"The transaction total","format":"double","title":"Total","type":"number"},"total_in_base_currency":{"description":"The transaction total in base currency","format":"double","title":"Total In Base Currency","type":"number"},"total_settled_in_base_currency":{"description":"The amount settled, in base currency","format":"float","title":"Total Settled In Base Currency","type":"number"},"transaction_id":{"description":"The transaction id of the capture","title":"Transaction","type":"string"},"type":{"description":"The type of payment","enum":["ach","cash","cashiers check","check","credit card","electronic check","money order","offline credit card","payroll deduction","purchase order","store credit","wire transfer"],"title":"Type","type":"string"},"uses_v2_api":{"description":"If set, this payment was processed via the synchronous API, vs step functions","title":"Uses V2 Api","type":"boolean"},"was_generated_by_order":{"description":"If this was generated by the order process","title":"Was Generated By Order","type":"boolean"},"workflow_execution_id":{"description":"The ID of the state machine execution used to create this transaction","title":"Workflow Execution","type":"string"}},"required":["bank_account_id","batch_id","business_unit_id","cash_account_type","contact_id","electronic_payment_info","id","line_items","merchant_account_id","number","organization_id","owner_type","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id","total","total_in_base_currency","type"],"type":"object"}},"components/schemas/PaymentReceiptTemplate":{"id":"components/schemas/PaymentReceiptTemplate","kind":"json-schema","title":"PaymentReceiptTemplate","data":{"additionalProperties":false,"properties":{"email":{"additionalProperties":false,"description":"The email to send with this template","properties":{"bcc":{"description":"Anyone that should be bcc'ed on the email","title":"Bcc","type":"string"},"body":{"description":"The email body","title":"Body","type":"string"},"cc":{"description":"Anyone that should be cc'ed on the email","title":"Cc","type":"string"},"from":{"description":"From email address","title":"From","type":"string"},"from_name":{"description":"From name","title":"From Name","type":"string"},"reply_to":{"description":"The reply to","title":"Reply To","type":"string"},"subject":{"description":"The email subject","title":"Subject","type":"string"}},"required":["body","subject"],"title":"Email","type":"object"},"id":{"description":"The unique, string identifier of this statement template","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether or not this statement template is active","title":"Is Active","type":"boolean"},"name":{"description":"The name of the statement template","title":"Name","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"template":{"description":"The template","title":"Template","type":"string"}},"required":["id","name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id","template"],"type":"object"}},"components/schemas/PaymentSearchParameters":{"id":"components/schemas/PaymentSearchParameters","kind":"json-schema","title":"PaymentSearchParameters","data":{"additionalProperties":false,"properties":{"bank_account_id":{"items":{"type":"string"},"maxItems":2,"minItems":2,"title":"Bank Account","type":"array"},"batch_id":{"items":{"type":"string"},"title":"Batch","type":"array"},"business_unit_id":{"description":"The business unit","title":"Business Unit","type":"string"},"contact_id":{"title":"Contact","type":"string"},"credit_card_type":{"items":{"type":"string"},"maxItems":2,"minItems":2,"title":"Credit Card Type","type":"array"},"date":{"items":{"type":"string"},"maxItems":2,"minItems":2,"title":"Date","type":"array"},"id":{"items":{"type":"string"},"title":"ID","type":"array"},"merchant_account_id":{"items":{"type":"string"},"maxItems":2,"minItems":2,"title":"Merchant Account","type":"array"},"number":{"items":{"format":"float","type":"number"},"maxItems":2,"minItems":2,"title":"Number","type":"array"},"organization_id":{"title":"Organization","type":"string"},"owner_type":{"title":"Owner Type","type":"string"},"reference_number":{"title":"Reference Number","type":"string"},"status":{"items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"title":"Status","type":"array"},"total":{"items":{"format":"float","type":"number"},"maxItems":2,"minItems":2,"title":"Total","type":"array"},"total_in_base_currency":{"items":{"format":"float","type":"number"},"maxItems":2,"minItems":2,"title":"Total In Base Currency","type":"array"},"transaction_id":{"items":{"type":"string"},"maxItems":2,"minItems":2,"title":"Transaction","type":"array"},"type":{"items":{"format":"date-time","type":"string"},"maxItems":2,"minItems":2,"title":"Type","type":"array"}},"required":["business_unit_id"],"type":"object"}},"components/schemas/PaymentSearchResults":{"id":"components/schemas/PaymentSearchResults","kind":"json-schema","title":"PaymentSearchResults","data":{"additionalProperties":false,"properties":{"bank_account_id":{"title":"Bank Account","type":"string"},"base_currency_symbol":{"title":"Base Currency Symbol","type":"string"},"batch_id":{"title":"Batch","type":"string"},"business_unit_id":{"description":"The business unit","title":"Business Unit","type":"string"},"contact_id":{"title":"Contact","type":"string"},"credit_card_type":{"title":"Credit Card Type","type":"string"},"currency_symbol":{"title":"Currency Symbol","type":"string"},"date":{"title":"Date","type":"string"},"id":{"title":"ID","type":"string"},"merchant_account_id":{"title":"Merchant Account","type":"string"},"number":{"format":"float","title":"Number","type":"number"},"organization_id":{"title":"Organization","type":"string"},"owner_type":{"title":"Owner Type","type":"string"},"reference_number":{"title":"Reference Number","type":"string"},"status":{"title":"Status","type":"string"},"total":{"format":"float","title":"Total","type":"number"},"total_in_base_currency":{"format":"float","title":"Total In Base Currency","type":"number"},"transaction_id":{"title":"Transaction","type":"string"},"type":{"title":"Type","type":"string"}},"required":["business_unit_id"],"type":"object"}},"components/schemas/PostBatches":{"id":"components/schemas/PostBatches","kind":"json-schema","title":"PostBatches","data":{"additionalProperties":false,"properties":{"batch_ids":{"description":"The IDs of the batches to post","items":{"type":"string"},"minItems":1,"title":"Batches","type":"array"},"business_unit_id":{"description":"The business unit","title":"Business Unit","type":"string"}},"required":["batch_ids","business_unit_id"],"type":"object"}},"components/schemas/PreviewBatchTemplateRequest":{"id":"components/schemas/PreviewBatchTemplateRequest","kind":"json-schema","title":"PreviewBatchTemplateRequest","data":{"additionalProperties":false,"properties":{"file_name_template":{"title":"File Name Template","type":"string"},"template":{"title":"Template","type":"string"}},"required":["file_name_template","template"],"type":"object"}},"components/schemas/PreviewEmailRequest":{"id":"components/schemas/PreviewEmailRequest","kind":"json-schema","title":"PreviewEmailRequest","data":{"additionalProperties":false,"properties":{"contact_id":{"title":"Contact","type":"string"},"customer_type":{"title":"Customer Type","type":"string"},"destination_email_address":{"title":"Destination Email Address","type":"string"},"email_template":{"additionalProperties":false,"properties":{"bcc":{"description":"Anyone that should be bcc'ed on the email","title":"Bcc","type":"string"},"body":{"description":"The email body","title":"Body","type":"string"},"cc":{"description":"Anyone that should be cc'ed on the email","title":"Cc","type":"string"},"from":{"description":"From email address","title":"From","type":"string"},"from_name":{"description":"From name","title":"From Name","type":"string"},"reply_to":{"description":"The reply to","title":"Reply To","type":"string"},"subject":{"description":"The email subject","title":"Subject","type":"string"}},"required":["body","subject"],"title":"Email Template","type":"object"},"invoice_id":{"title":"Invoice","type":"string"},"organization_id":{"title":"Organization","type":"string"},"payment_id":{"title":"Payment","type":"string"}},"required":["contact_id","customer_type","destination_email_address","organization_id"],"type":"object"}},"components/schemas/PreviewTemplateRequest":{"id":"components/schemas/PreviewTemplateRequest","kind":"json-schema","title":"PreviewTemplateRequest","data":{"additionalProperties":false,"properties":{"contact_id":{"title":"Contact","type":"string"},"customer_type":{"enum":["contact","organization"],"title":"Customer Type","type":"string"},"id":{"description":"The refund id","title":"ID","type":"string"},"invoice_id":{"title":"Invoice","type":"string"},"organization_id":{"title":"Organization","type":"string"},"template":{"title":"Template","type":"string"}},"required":["contact_id","customer_type","organization_id","template"],"type":"object"}},"components/schemas/ProcessingRequest":{"id":"components/schemas/ProcessingRequest","kind":"json-schema","title":"ProcessingRequest","data":{"additionalProperties":false,"properties":{"batch_id":{"description":"The batch being used","title":"Batch","type":"string"},"billing_run_action_id":{"description":"If this is associated with a billing action, the information is here","title":"Billing Run Action","type":"string"},"billing_run_id":{"description":"The billing run","title":"Billing Run","type":"string"},"entry_ids":{"items":{"type":"string"},"title":"Entries","type":"array"},"process_by":{"enum":["entry ids","reference date"],"title":"Process By","type":"string"},"reference_date":{"description":"The reference date","format":"date-time","title":"Reference Date","type":"string"},"schedule_id":{"description":"The schedule","title":"Schedule","type":"string"}},"required":["batch_id","entry_ids","reference_date","schedule_id"],"type":"object"}},"components/schemas/ProductFinancialConfig":{"id":"components/schemas/ProductFinancialConfig","kind":"json-schema","title":"ProductFinancialConfig","data":{"additionalProperties":false,"properties":{"accounting_project_id":{"description":"The accounting project for this project","title":"Accounting Project","type":"string"},"accounts_receivable_gl_account_id":{"description":"The A/R GL account","title":"Accounts Receivable Gl Account","type":"string"},"business_unit_id":{"description":"The business unit id","title":"Business Unit","type":"string"},"cogs_expense_gl_account_id":{"description":"The COGS account","title":"Cogs Expense Gl Account","type":"string"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"deferral_fixed_dates":{"items":{"additionalProperties":false,"properties":{"date":{"description":"The date for deferral","format":"date-time","title":"Date","type":"string"},"percentage":{"description":"The percentage to defer","format":"double","maximum":100,"minimum":0,"title":"Percentage","type":"number"}},"type":"object"},"minItems":1,"type":"array"},"deferral_schedule_calculation_strategy":{"description":"How the revenue recognition schedule is calculated","enum":["automatic","fixed dates"],"title":"Deferral Schedule Calculation Strategy","type":"string"},"deferred_revenue_gl_account_id":{"description":"The deferred revenue account","title":"Deferred Revenue Gl Account","type":"string"},"department_id":{"description":"The department for this project","title":"Department","type":"string"},"due_to_due_from_entries":{"items":{"additionalProperties":false,"properties":{"accounts_receivable_gl_account_id":{"description":"The A/R G/L","title":"Accounts Receivable Gl Account","type":"string"},"business_unit_id":{"description":"The business unit","title":"Business Unit","type":"string"},"liability_gl_account_id":{"description":"The liability G/L account ID","title":"Liability Gl Account","type":"string"}},"required":["accounts_receivable_gl_account_id","business_unit_id","liability_gl_account_id"],"type":"object"},"minItems":1,"type":"array"},"enable_deferred_revenue_recognition":{"description":"Whether or not revenue should be deferred","title":"Enable Deferred Revenue Recognition","type":"boolean"},"enable_revenue_splits":{"description":"Whether or not the product should split revenue","title":"Enable Revenue Splits","type":"boolean"},"id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique, string identifier of this product financial configuration. This should be in the format [product type]-[product id]"},"children":[]}]}]}],"pattern":"^[\\w\\-_\\s,&@\\.\\\\|]+$","title":"ID","type":"string"},"inventory_gl_account_id":{"description":"The inventory gl account","title":"Inventory Gl Account","type":"string"},"merchant_account_id":{"description":"The merchant account that all payments should be routed to; if set, all orders with this product will be split up to ensure payments to this product end up in the specified merchant account","title":"Merchant Account","type":"string"},"notes":{"description":"notes","title":"Notes","type":"string"},"product_id":{"description":"The id of product","title":"Product","type":"string"},"product_type":{"description":"The type of product","title":"Product Type","type":"string"},"revenue_gl_account_id":{"description":"The revenue GL account","title":"Revenue Gl Account","type":"string"},"revenue_splits":{"items":{"additionalProperties":false,"properties":{"amount":{"format":"double","minimum":0,"oneOf":[{"x-required":true}],"title":"Amount","type":"number"},"name":{"title":"Name","type":"string"},"percentage":{"format":"double","maximum":100,"minimum":0,"oneOf":[{"x-required":true}],"title":"Percentage","type":"number"},"revenue_gl_account_id":{"description":"The revenue account id","title":"Revenue Gl Account","type":"string"},"revenue_split_id":{"title":"Revenue Split","type":"string"},"type":{"enum":["fixed amount","percentage"],"title":"Type","type":"string"}},"type":"object"},"minItems":1,"type":"array"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"tax_class_id":{"description":"The tax class of this product","title":"Tax Class","type":"string"},"write_off_gl_account_id":{"description":"The write off account","title":"Write Off Gl Account","type":"string"}},"required":["business_unit_id","deferral_fixed_dates","deferred_revenue_gl_account_id","id","product_id","product_type","revenue_gl_account_id","revenue_splits","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/PublicInvoiceInfo":{"id":"components/schemas/PublicInvoiceInfo","kind":"json-schema","title":"PublicInvoiceInfo","data":{"additionalProperties":false,"properties":{"allowed_payment_methods":{"enum":["both","credit card","electronic check"],"title":"Allowed Payment Methods","type":"string"},"balance_due":{"description":"The balance due on the invoice","format":"float","title":"Balance Due","type":"number"},"date":{"description":"The date of the invoice","format":"date-time","title":"Date","type":"string"},"date_due":{"description":"The date of the invoice","format":"date-time","title":"Date Due","type":"string"},"id":{"description":"The ID of the invoice","title":"ID","type":"string"},"number":{"description":"Invoice number","format":"float","title":"Number","type":"number"},"status":{"description":"The status of the invoice","enum":["cancelled","open","paid","void","written off"],"title":"Status","type":"string"}},"type":"object"}},"components/schemas/PublicPaymentRequest":{"id":"components/schemas/PublicPaymentRequest","kind":"json-schema","title":"PublicPaymentRequest","data":{"additionalProperties":false,"properties":{"contact_info":{"additionalProperties":false,"description":"The contact information for the payee","properties":{},"title":"Contact Info","type":"object"},"invoice_id":{"description":"The ID of the invoice being paid","title":"Invoice","type":"string"},"payment":{"additionalProperties":false,"description":"The payment information","properties":{},"title":"Payment","type":"object"},"sharing_secret":{"description":"The sharing secret of the invoice being paid","title":"Sharing Secret","type":"string"}},"required":["contact_info","invoice_id","payment","sharing_secret"],"type":"object"}},"components/schemas/RecurringBatch":{"id":"components/schemas/RecurringBatch","kind":"json-schema","title":"RecurringBatch","data":{"additionalProperties":false,"properties":{"active_batch_id":{"description":"The current active batch for this recurrence","title":"Active Batch","type":"string"},"batch_id_template":{"description":"The optional pattern for IDs for batches generated","title":"Batch Id Template","type":"string"},"batch_name_template":{"description":"The naming pattern for batches generated","title":"Batch Name Template","type":"string"},"business_unit_id":{"description":"The business unit that this batch is tied to","title":"Business Unit","type":"string"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"description":{"description":"The name of the recurring batch","title":"Description","type":"string"},"errors_since_last_run":{"description":"The number of errors that have occurred since the last successful run of this schedule","format":"float","title":"Errors Since Last Run","type":"number"},"human_readable_schedule":{"description":"A human readable schedule for display","title":"Human Readable Schedule","type":"string"},"id":{"description":"The unique, string identifier of this recurring batch","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether this process is active","title":"Is Active","type":"boolean"},"last_error":{"description":"The last error on this process","title":"Last Error","type":"string"},"last_error_date":{"description":"The last time this process encountered an error","format":"date-time","title":"Last Error Date","type":"string"},"last_run_date":{"description":"The last time this process was run","format":"date-time","title":"Last Run Date","type":"string"},"name":{"description":"The name of the recurring batch","title":"Name","type":"string"},"schedule":{"description":"The schedule which defines how often the batch should be created","title":"Schedule","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_next_processing_date":{"description":"Internal system field, do not modify","format":"date-time","title":"Sys Next Processing Date","type":"string"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_suppress_new_batch_creation":{"description":"If true, a new batch is not created","title":"Sys Suppress New Batch Creation","type":"boolean"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"}},"required":["batch_name_template","business_unit_id","id","name","schedule","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/RecurringBillingRun":{"id":"components/schemas/RecurringBillingRun","kind":"json-schema","title":"RecurringBillingRun","data":{"additionalProperties":false,"properties":{"errors_since_last_run":{"description":"The number of errors that have occurred since the last successful run of this schedule","format":"float","title":"Errors Since Last Run","type":"number"},"human_readable_schedule":{"description":"A human readable schedule for display","title":"Human Readable Schedule","type":"string"},"id":{"description":"The unique, string identifier of this recurring billing run","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether this process is active","title":"Is Active","type":"boolean"},"last_error":{"description":"The last error on this process","title":"Last Error","type":"string"},"last_error_date":{"description":"The last time this process encountered an error","format":"date-time","title":"Last Error Date","type":"string"},"last_run_date":{"description":"The last time this process was run","format":"date-time","title":"Last Run Date","type":"string"},"name":{"description":"The name of the recurring billing run","title":"Name","type":"string"},"pre_processing_lead_time":{"description":"The number of business days before the run date that the system should pre process the run and allow it to be reviewed","format":"float","minimum":1,"title":"Pre Processing Lead Time","type":"number"},"schedule":{"description":"The schedule which defines how often the batch should be created","title":"Schedule","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_next_processing_date":{"description":"Internal system field, do not modify","format":"date-time","title":"Sys Next Processing Date","type":"string"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"template_id":{"description":"The template to use","title":"Template","type":"string"}},"required":["id","name","pre_processing_lead_time","schedule","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id","template_id"],"type":"object"}},"components/schemas/Refund":{"id":"components/schemas/Refund","kind":"json-schema","title":"Refund","data":{"additionalProperties":false,"properties":{"bank_account_id":{"description":"The bank account to use for this payment","title":"Bank Account","type":"string"},"base_currency_code":{"description":"The base currency for transactions business unit","maxLength":3,"minLength":3,"title":"Base Currency Code","type":"string"},"base_currency_symbol":{"description":"The base symbol for the transactions business unit","title":"Base Currency Symbol","type":"string"},"batch_id":{"description":"The batch this transaction belongs to","title":"Batch","type":"string"},"business_unit_id":{"description":"The business unit this transaction belongs to","title":"Business Unit","type":"string"},"cancellation_id":{"description":"The order cancellation tied to this transaction","title":"Cancellation","type":"string"},"cash_account_type":{"description":"Type of cash account to use","enum":["bank","merchant","none"],"title":"Cash Account Type","type":"string"},"confirmation_email_recipients":{"description":"Send a confirmation email to these recipients","items":{"type":"string"},"title":"Confirmation Email Recipients","type":"array"},"credit_id":{"description":"The credit being refunded","title":"Credit","type":"string"},"currency_code":{"description":"The currency code in use","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHF","CLP","CNY","COP","CRC","CUC","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GQE","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZM","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SYP","SZL","THB","TJS","TMT","TND","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYU","UZS","VEB","VND","VUV","WST","XAF","XCD","XDR","XOF","XPF","YER","ZAR","ZMK","ZWR"],"maxLength":3,"minLength":3,"title":"Currency Code","type":"string"},"currency_symbol":{"description":"The currency symbol","title":"Currency Symbol","type":"string"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"date":{"description":"The date of the transaction","format":"date","title":"Date","type":"string"},"do_not_perform_electronic_refund":{"description":"If set, the refund process will NOT perform an electronic refund","title":"Do Not Perform Electronic Refund","type":"boolean"},"exchange_rate":{"description":"The exchange rate, if applicable","format":"double","title":"Exchange Rate","type":"number"},"id":{"description":"The unique, string identifier of this refund","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"ignore_payment_gateway_errors":{"description":"If true, payment gateway errors are ignored","title":"Ignore Payment Gateway Errors","type":"boolean"},"line_items":{"items":{"additionalProperties":false,"oneOf":[{"type":"object","properties":{"payment_line_item_id":{},"total_in_base_currency":{},"refund_line_item_id":{}},"required":["payment_line_item_id","total_in_base_currency","refund_line_item_id"],"additionalProperties":false}],"properties":{"payment_line_item_id":{"description":"Line item id of the payment","title":"Payment Line Item","type":"string"},"refund_line_item_id":{"description":"The line item id of the refund","title":"Refund Line Item","type":"string"},"total":{"description":"Total of the line item","format":"double","title":"Total","type":"number"},"total_in_base_currency":{"description":"The total of the transaction, in the base currency of the business unit.","format":"double","title":"Total In Base Currency","type":"number"}},"required":["total"],"type":"object"},"type":"array"},"memo":{"description":"Memo/description of the transaction","title":"Memo","type":"string"},"merchant_account_id":{"description":"The merchant account to use for this payment","title":"Merchant Account","type":"string"},"notes":{"description":"Notes fro the transaction","title":"Notes","type":"string"},"number":{"description":"The transaction number","title":"Number","type":"integer"},"order_id":{"description":"The order tied to this transaction","title":"Order","type":"string"},"payment_id":{"description":"The payment being refunded","title":"Payment","type":"string"},"return_id":{"description":"The return tied to this transaction","title":"Return","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_search_composite_key":{"description":"Internal use","title":"Sys Search Composite Key","type":"string"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"total":{"description":"The transaction total","format":"double","title":"Total","type":"number"},"total_in_base_currency":{"description":"The total of the transaction, in the base currency of the business unit.","format":"double","title":"Total In Base Currency","type":"number"},"transaction_id":{"description":"For electronic refunds, the transaction id","title":"Transaction","type":"string"},"type":{"description":"The type of object being refunded","enum":["credit","payment"],"title":"Type","type":"string"},"workflow_execution_id":{"description":"The ID of the state machine execution used to create this transaction","title":"Workflow Execution","type":"string"}},"required":["bank_account_id","batch_id","business_unit_id","cash_account_type","credit_id","id","merchant_account_id","number","payment_id","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id","total","total_in_base_currency","type"],"type":"object"}},"components/schemas/RefundReceiptTemplate":{"id":"components/schemas/RefundReceiptTemplate","kind":"json-schema","title":"RefundReceiptTemplate","data":{"additionalProperties":false,"properties":{"email":{"additionalProperties":false,"description":"The email to send with this template","properties":{"bcc":{"description":"Anyone that should be bcc'ed on the email","title":"Bcc","type":"string"},"body":{"description":"The email body","title":"Body","type":"string"},"cc":{"description":"Anyone that should be cc'ed on the email","title":"Cc","type":"string"},"from":{"description":"From email address","title":"From","type":"string"},"from_name":{"description":"From name","title":"From Name","type":"string"},"reply_to":{"description":"The reply to","title":"Reply To","type":"string"},"subject":{"description":"The email subject","title":"Subject","type":"string"}},"required":["body","subject"],"title":"Email","type":"object"},"id":{"description":"The unique, string identifier of this template","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether or not this template is active","title":"Is Active","type":"boolean"},"name":{"description":"The name of the template","title":"Name","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"template":{"description":"The template","title":"Template","type":"string"}},"required":["id","name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id","template"],"type":"object"}},"components/schemas/RefundSearchParameters":{"id":"components/schemas/RefundSearchParameters","kind":"json-schema","title":"RefundSearchParameters","data":{"additionalProperties":false,"properties":{"bank_account_id":{"items":{"type":"string"},"maxItems":2,"minItems":2,"title":"Bank Account","type":"array"},"batch_id":{"items":{"type":"string"},"title":"Batch","type":"array"},"business_unit_id":{"description":"The business unit","title":"Business Unit","type":"string"},"date":{"items":{"type":"string"},"maxItems":2,"minItems":2,"title":"Date","type":"array"},"id":{"items":{"type":"string"},"title":"ID","type":"array"},"merchant_account_id":{"items":{"type":"string"},"maxItems":2,"minItems":2,"title":"Merchant Account","type":"array"},"number":{"items":{"format":"float","type":"number"},"maxItems":2,"minItems":2,"title":"Number","type":"array"},"total":{"items":{"format":"float","type":"number"},"maxItems":2,"minItems":2,"title":"Total","type":"array"},"total_in_base_currency":{"items":{"format":"float","type":"number"},"maxItems":2,"minItems":2,"title":"Total In Base Currency","type":"array"},"transaction_id":{"title":"Transaction","type":"string"}},"required":["business_unit_id"],"type":"object"}},"components/schemas/RefundSearchResults":{"id":"components/schemas/RefundSearchResults","kind":"json-schema","title":"RefundSearchResults","data":{"additionalProperties":false,"properties":{"bank_account_id":{"title":"Bank Account","type":"string"},"base_currency_symbol":{"title":"Base Currency Symbol","type":"string"},"batch_id":{"title":"Batch","type":"string"},"business_unit_id":{"description":"The business unit","title":"Business Unit","type":"string"},"currency_symbol":{"title":"Currency Symbol","type":"string"},"date":{"title":"Date","type":"string"},"id":{"title":"ID","type":"string"},"merchant_account_id":{"title":"Merchant Account","type":"string"},"number":{"format":"float","title":"Number","type":"number"},"total":{"format":"float","title":"Total","type":"number"},"total_in_base_currency":{"format":"float","title":"Total In Base Currency","type":"number"}},"required":["business_unit_id"],"type":"object"}},"components/schemas/RegenerateLegacyOpenInvoiceResult":{"id":"components/schemas/RegenerateLegacyOpenInvoiceResult","kind":"json-schema","title":"RegenerateLegacyOpenInvoiceResult","data":{"additionalProperties":false,"properties":{"batch_id":{"title":"Batch","type":"string"},"errors":{"format":"float","title":"Errors","type":"number"},"success":{"format":"float","title":"Success","type":"number"},"total":{"format":"float","title":"Total","type":"number"}},"type":"object"}},"components/schemas/RelatedTransactions":{"id":"components/schemas/RelatedTransactions","kind":"json-schema","title":"RelatedTransactions","data":{"items":{"additionalProperties":false,"properties":{"amount":{"description":"The amount applied","format":"double","type":"number"},"date":{"description":"The date/time of the transaction","format":"date-time","type":"string"},"transaction_id":{"description":"The id of the transaction","type":"string"},"transaction_line_item_id":{"description":"The line item id of the transaction","type":"string"},"transaction_number":{"description":"The number of the transaction","format":"float","type":"number"},"type":{"enum":["cancellation","credit","credit memo","credit usage","debit memo","invoice","payment","refund","return","shipment","write off"],"type":"string"}},"required":["amount","date","transaction_id","transaction_line_item_id","transaction_number"],"type":"object"},"type":"array"}},"components/schemas/RevenueRecognitionSchedule":{"id":"components/schemas/RevenueRecognitionSchedule","kind":"json-schema","title":"RevenueRecognitionSchedule","data":{"additionalProperties":false,"properties":{"batch_id":{"description":"The batch that posted the schedule","title":"Batch","type":"string"},"business_unit_id":{"description":"The business unit this schedule belongs to","title":"Business Unit","type":"string"},"contact_id":{"description":"Contact that owns this","title":"Contact","type":"string"},"credit_memo_id":{"title":"Credit Memo","type":"string"},"currency_code":{"description":"The currency code for the revenue recognition schedule","maxLength":3,"minLength":3,"title":"Currency Code","type":"string"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"customer_type":{"description":"The type of customer that \"owns\" this schedule","title":"Customer Type","type":"string"},"date":{"title":"Date","type":"string"},"debit_memo_id":{"title":"Debit Memo","type":"string"},"deferred_revenue_gl_account_id":{"title":"Deferred Revenue Gl Account","type":"string"},"entries":{"items":{"additionalProperties":false,"properties":{"amount":{"format":"double","title":"Amount","type":"number"},"batch_id":{"description":"The batch that recognized this entry","oneOf":[{"x-required":true}],"title":"Batch","type":"string"},"cogs_batch_id":{"description":"The ID of the batch used to track COGS","title":"Cogs Batch","type":"string"},"date":{"title":"Date","type":"string"},"deferral_batch_id":{"description":"The ID of the batch used to process deferrals","title":"Deferral Batch","type":"string"},"deferred_revenue_gl_account_id":{"title":"Deferred Revenue Gl Account","type":"string"},"entry_id":{"title":"Entry","type":"string"},"parent_entry_id":{"title":"Parent Entry","type":"string"},"recognized_in_fiscal_period":{"description":"The fiscal period in which this entry was recognized","format":"float","maximum":23,"minimum":1,"title":"Recognized In Fiscal Period","type":"number"},"recognized_in_fiscal_year_id":{"description":"The fiscal year in which this entry was recognized","title":"Recognized In Fiscal Year","type":"string"},"revenue_gl_account_id":{"title":"Revenue Gl Account","type":"string"},"revenue_split_id":{"title":"Revenue Split","type":"string"},"status":{"enum":["error","recognized","unrecognized"],"title":"Status","type":"string"}},"required":["amount","date","deferred_revenue_gl_account_id","entry_id","revenue_gl_account_id","status"],"type":"object"},"minItems":1,"type":"array"},"id":{"description":"The unique, string identifier of this revenue recognition schedule","pattern":"^[\\w:|-]+$","title":"ID","type":"string"},"invoice_id":{"title":"Invoice","type":"string"},"invoice_line_item_id":{"title":"Invoice Line Item","type":"string"},"membership_id":{"description":"The membership this schedule is tied to","title":"Membership","type":"string"},"notes":{"description":"Optional notes/description for the schedule","title":"Notes","type":"string"},"organization_id":{"description":"Organization that owns this","title":"Organization","type":"string"},"parent_schedule_id":{"description":"The parent schedule, if this schedule is related to another","title":"Parent Schedule","type":"string"},"payment_id":{"title":"Payment","type":"string"},"payment_line_item_id":{"title":"Payment Line Item","type":"string"},"product_id":{"description":"The ID of the product","title":"Product","type":"string"},"product_name":{"description":"The name of the product","title":"Product Name","type":"string"},"product_type":{"description":"The type of product being deferred","title":"Product Type","type":"string"},"product_version":{"description":"The versino of the product that created this schedule","format":"float","title":"Product Version","type":"number"},"recognized_amount":{"description":"The amount of revenue that has been recognized","format":"float","title":"Recognized Amount","type":"number"},"refund_id":{"title":"Refund","type":"string"},"revenue_gl_account_id":{"title":"Revenue Gl Account","type":"string"},"revenue_splits":{"items":{"additionalProperties":false,"properties":{"amount":{"format":"double","minimum":0,"oneOf":[{"x-required":true}],"title":"Amount","type":"number"},"percentage":{"format":"double","maximum":100,"minimum":0,"oneOf":[{"x-required":true}],"title":"Percentage","type":"number"},"revenue_gl_account_id":{"title":"Revenue Gl Account","type":"string"},"revenue_split_id":{"title":"Revenue Split","type":"string"},"type":{"enum":["fixed amount","percentage"],"title":"Type","type":"string"}},"required":["revenue_gl_account_id","revenue_split_id"],"type":"object"},"type":"array"},"status":{"enum":["closed","open"],"title":"Status","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_business_unit_status":{"description":"Concatenation of the business unit id and the status, used for indexing","title":"Sys Business Unit Status","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"total":{"description":"The total to be recognized in this schedule","format":"float","title":"Total","type":"number"},"transaction_id":{"description":"The transaction ID","title":"Transaction","type":"string"},"type":{"enum":["credit memo","debit memo","invoice","payment","refund","write off"],"title":"Type","type":"string"},"unrecognized_amount":{"description":"The unrecognized amount of revenue","format":"float","title":"Unrecognized Amount","type":"number"},"write_off_id":{"title":"Write Off","type":"string"}},"required":["batch_id","business_unit_id","credit_memo_id","currency_code","debit_memo_id","deferred_revenue_gl_account_id","entries","id","invoice_id","invoice_line_item_id","payment_id","payment_line_item_id","product_id","product_type","recognized_amount","refund_id","revenue_gl_account_id","status","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id","total","transaction_id","type","unrecognized_amount","write_off_id"],"type":"object"}},"components/schemas/SearchParameters":{"id":"components/schemas/SearchParameters","kind":"json-schema","title":"SearchParameters","data":{"additionalProperties":false,"properties":{"batch_id":{"items":{"type":"string"},"title":"Batch","type":"array"},"business_unit_id":{"description":"The business unit","title":"Business Unit","type":"string"},"transaction_date":{"additionalProperties":false,"properties":{"end":{"format":"date-time","title":"End","type":"string"},"start":{"format":"date-time","title":"Start","type":"string"}},"title":"Transaction Date","type":"object"},"transaction_id":{"items":{"type":"string"},"title":"Transaction","type":"array"},"transaction_number":{"additionalProperties":false,"properties":{"end":{"format":"float","title":"End","type":"number"},"start":{"format":"float","title":"Start","type":"number"}},"title":"Transaction Number","type":"object"},"transaction_total":{"additionalProperties":false,"properties":{"end":{"format":"float","title":"End","type":"number"},"start":{"format":"float","title":"Start","type":"number"}},"title":"Transaction Total","type":"object"}},"required":["business_unit_id"],"type":"object"}},"components/schemas/Setting":{"id":"components/schemas/Setting","kind":"json-schema","title":"Setting","data":{"additionalProperties":false,"properties":{"allow_echecks_when_paying_open_invoices":{"description":"If true, eChecks are allowed to pay open invoices","title":"Allow Echecks When Paying Open Invoices","type":"boolean"},"contact_role_permissions":{"description":"The contact roles that are allowed to manage this scholarship","items":{"additionalProperties":false,"properties":{"make_payments":{"description":"This role can make payments for the organization","title":"Make Payments","type":"boolean"},"role_id":{"description":"The contact role","title":"Role","type":"string"},"view_financial_history":{"description":"This role can view the financial history of an organization","title":"View Financial History","type":"boolean"}},"type":"object"},"type":"array"},"default_customer_statement_template_id":{"description":"The default customer statement ID to use","title":"Default Customer Statement Template","type":"string"},"default_merchant_account_id":{"description":"The default merchant account to use when none is specified","title":"Default Merchant Account","type":"string"},"disable_saving_credit_cards_when_paying_open_invoices":{"title":"Disable Saving Credit Cards When Paying Open Invoices","type":"boolean"},"enable_publicly_payable_invoices":{"description":"If set, customers are able to share invoices and pay for them without logging in","title":"Enable Publicly Payable Invoices","type":"boolean"},"gl_information_guidance":{"description":"HTML/text to display to administrators to help them choose the appropriate G/L information","title":"Gl Information Guidance","type":"string"},"modify_gl_information_during_product_editing":{"description":"Whether or not users should be able to see/modify G/L information while editing products","enum":["disabled","optional","required"],"title":"Modify Gl Information During Product Editing","type":"string"},"notes":{"title":"Notes","type":"string"},"payment_processor":{"description":"Payment processor","enum":["legacy","payrix","stripe"],"title":"Payment Processor","type":"string"},"prompt_for_auto_renewal_when_paying_membership_invoices":{"description":"If set, users who pay for membership packages in the portal are given the option to auto renew IF and only if they do not have it set already","enum":["disabled","opt in","opt out"],"title":"Prompt For Auto Renewal When Paying Membership Invoices","type":"string"},"publicly_payable_invoice_options":{"additionalProperties":false,"properties":{"allowed_payment_methods":{"enum":["both","credit card","electronic check"],"title":"Allowed Payment Methods","type":"string"},"site_id":{"description":"The portal site to use for sharing","title":"Site","type":"string"}},"required":["allowed_payment_methods","site_id"],"title":"Publicly Payable Invoice Options","type":"object"},"stripe_options":{"additionalProperties":false,"properties":{"enable_cash_app":{"description":"CashApp is enabled","title":"Enable Cash App","type":"boolean"},"enable_link":{"description":"If set, the 1-click link payment is enabled","title":"Enable Link","type":"boolean"},"enable_paypal":{"description":"Enable PayPal","title":"Enable Paypal","type":"boolean"},"mode":{"description":"Defines the mode; when multiple accounts are used, the system stores transactions on the platform account","enum":["multiple accounts","single account"],"title":"Mode","type":"string"},"primary_stripe_account_id":{"description":"The primary account to use","title":"Primary Stripe Account","type":"string"}},"required":["mode","primary_stripe_account_id"],"title":"Stripe Options","type":"object"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"}},"required":["publicly_payable_invoice_options","stripe_options","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/StandardQueryDefinition":{"id":"components/schemas/StandardQueryDefinition","kind":"json-schema","title":"StandardQueryDefinition","data":{"additionalProperties":false,"properties":{"category":{"title":"Category","type":"string"},"definition":{"additionalProperties":false,"properties":{},"title":"Definition","type":"object"},"id":{"title":"ID","type":"string"},"name":{"title":"Name","type":"string"}},"type":"object"}},"components/schemas/Statement":{"id":"components/schemas/Statement","kind":"json-schema","title":"Statement","data":{"additionalProperties":false,"properties":{"contact_id":{"title":"Contact","type":"string"},"customer_type":{"enum":["contact","organization"],"title":"Customer Type","type":"string"},"date":{"description":"Statement date","title":"Date","type":"string"},"id":{"description":"The unique, string identifier of this statement","pattern":"^[\\w:|-]+$","title":"ID","type":"string"},"notes":{"title":"Notes","type":"string"},"number":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Statement #"},"children":[]}]}]}],"format":"float","title":"Number","type":"number"},"open_balance":{"description":"The balance on the statement","format":"float","title":"Open Balance","type":"number"},"open_credits":{"description":"The open credits on the statement","format":"float","title":"Open Credits","type":"number"},"organization_id":{"title":"Organization","type":"string"},"statement_uri":{"description":"The statement","title":"Statement Uri","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"}},"required":["contact_id","customer_type","id","open_balance","open_credits","organization_id","statement_uri","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/StatementGenerationRequest":{"id":"components/schemas/StatementGenerationRequest","kind":"json-schema","title":"StatementGenerationRequest","data":{"additionalProperties":false,"properties":{"business_unit_ids":{"items":{"type":"string"},"minItems":1,"title":"Business Units","type":"array"},"business_unit_restriction":{"description":"Determines if/how to restrict the type of invoices to ","enum":["exclude","include","none"],"title":"Business Unit Restriction","type":"string"},"contact_id":{"title":"Contact","type":"string"},"customer_type":{"enum":["contact","organization"],"title":"Customer Type","type":"string"},"email_address":{"description":"Email address to send statement, if is on file","title":"Email Address","type":"string"},"email_statement":{"title":"Email Statement","type":"boolean"},"invoice_type_restriction":{"enum":["exclude","include","none"],"title":"Invoice Type Restriction","type":"string"},"invoice_types":{"items":{"type":"string"},"title":"Invoice Types","type":"array"},"organization_id":{"title":"Organization","type":"string"},"override_statement_template":{"description":"If set, a specific template is used","title":"Override Statement Template","type":"string"},"save_statement_on_customer_record":{"title":"Save Statement On Customer Record","type":"boolean"},"statement_template_id":{"description":"Template to use, if not the default","title":"Statement Template","type":"string"}},"required":["business_unit_ids","contact_id","customer_type","email_statement","organization_id","save_statement_on_customer_record"],"type":"object"}},"components/schemas/StatementTemplate":{"id":"components/schemas/StatementTemplate","kind":"json-schema","title":"StatementTemplate","data":{"additionalProperties":false,"properties":{"contact_role_ids":{"items":{"type":"string"},"minItems":1,"title":"Contact Roles","type":"array"},"email":{"additionalProperties":false,"description":"The email to send with this template","properties":{"bcc":{"description":"Anyone that should be bcc'ed on the email","title":"Bcc","type":"string"},"body":{"description":"The email body","title":"Body","type":"string"},"cc":{"description":"Anyone that should be cc'ed on the email","title":"Cc","type":"string"},"from":{"description":"From email address","title":"From","type":"string"},"from_name":{"description":"From name","title":"From Name","type":"string"},"reply_to":{"description":"The reply to","title":"Reply To","type":"string"},"subject":{"description":"The email subject","title":"Subject","type":"string"}},"required":["body","subject"],"title":"Email","type":"object"},"id":{"description":"The unique, string identifier of this statement template","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"is_active":{"description":"Whether or not this statement template is active","title":"Is Active","type":"boolean"},"name":{"description":"The name of the statement template","title":"Name","type":"string"},"send_to":{"description":"Whether to send notices to all contacts, or specific roles","enum":["all contacts","only certain roles"],"title":"Send To","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"template":{"description":"The template","title":"Template","type":"string"}},"required":["contact_role_ids","email","id","name","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id","template"],"type":"object"}},"components/schemas/Statistic":{"id":"components/schemas/Statistic","kind":"json-schema","title":"Statistic","data":{"additionalProperties":false,"properties":{"dataSource":{"description":"The datasource used to generate this value","title":"Datasource","type":"string"},"error":{"description":"If the cache encountered an error, this is it","title":"Error","type":"string"},"id":{"description":"The unique, string identifier of this statistic","pattern":"^[\\w-:%\\/]+$","title":"ID","type":"string"},"name":{"description":"The name of the statistic","title":"Name","type":"string"},"status":{"description":"The description of the statistic","enum":["error","processing","valid"],"title":"Status","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"value":{"description":"The numeric value of the statistic","format":"float","title":"Value","type":"number"},"value_difference_numeric":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When a value & previous value is present, this is the numeric difference"},"children":[]}]}]}],"format":"float","title":"Value Difference Numeric","type":"number"},"value_difference_percentage":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When a value & previous value is present, this is the percentage difference"},"children":[]}]}]}],"format":"float","title":"Value Difference Percentage","type":"number"},"value_for_previous_period":{"description":"For statistics that can compare values from a previous period, this is the value","format":"float","title":"Value For Previous Period","type":"number"},"values":{"description":"If the stat hs values in a row form, this variable contains it","items":{"additionalProperties":false,"properties":{},"type":"object"},"type":"array"}},"required":["id","name","status","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id","value"],"type":"object"}},"components/schemas/StepFunctionExecutionToken":{"id":"components/schemas/StepFunctionExecutionToken","kind":"json-schema","title":"StepFunctionExecutionToken","data":{"additionalProperties":false,"properties":{"executionArn":{"description":"The arn of the execution","title":"Executionarn","type":"string"},"notification_channel":{"description":"The id of the channel where progress updates will be posted","title":"Notification Channel","type":"string"},"notification_publishKey":{"description":"The publish key for the channel where progress updates will be posted","title":"Notification Publishkey","type":"string"},"notification_subscribeKey":{"description":"The subscribe key for the channel where progress updates will be posted","title":"Notification Subscribekey","type":"string"},"start_date":{"description":"The start date of the execution","format":"date-time","title":"Start Date","type":"string"}},"required":["executionArn"],"type":"object"}},"components/schemas/StoredPaymentMethod":{"id":"components/schemas/StoredPaymentMethod","kind":"json-schema","title":"StoredPaymentMethod","data":{"additionalProperties":false,"properties":{"billing_address":{"$ref":"#/components/schemas/Address"},"contact_id":{"description":"The name of the customer whose payment method is being stored","title":"Contact","type":"string"},"credit_card_type":{"description":"Credit card type","enum":["american express","discover","mastercard","other","visa"],"title":"Credit Card Type","type":"string"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"expires":{"description":"Date of expiration","format":"date","title":"Expires","type":"string"},"id":{"description":"The unique, string identifier of this stored payment method","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"last_four_digits":{"description":"Last four digits of the account number","maxLength":4,"minLength":4,"title":"Last Four Digits","type":"string"},"merchant_account_tokens":{"items":{"additionalProperties":false,"properties":{"merchant_account_id":{"description":"The merchant account being vaulted","title":"Merchant Account","type":"string"},"token":{"description":"The token for this payment method for the merchant account","title":"Token","type":"string"}},"required":["merchant_account_id","token"],"type":"object"},"minItems":1,"type":"array"},"name":{"description":"The name of the stored payment method","title":"Name","type":"string"},"name_on_account":{"description":"The name on the account","title":"Name On Account","type":"string"},"payrix_migrated":{"title":"Payrix Migrated","type":"boolean"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"type":{"description":"Type of stored payment","enum":["credit card","electronic check"],"title":"Type","type":"string"}},"required":["contact_id","credit_card_type","id","last_four_digits","merchant_account_tokens","name","name_on_account","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id","type"],"type":"object"}},"components/schemas/SubledgerEntry":{"id":"components/schemas/SubledgerEntry","kind":"json-schema","title":"SubledgerEntry","data":{"additionalProperties":false,"properties":{"batch_id":{"description":"The batch the entry is tied to","title":"Batch","type":"string"},"business_unit_id":{"description":"The business unit that the batch belongs in","title":"Business Unit","type":"string"},"cogs_entry_id":{"title":"Cogs Entry","type":"string"},"contact_id":{"title":"Contact","type":"string"},"credit_card_last_five_digits":{"description":"For payments, the last five digits of the credit card","title":"Credit Card Last Five Digits","type":"string"},"credit_id":{"title":"Credit","type":"string"},"credit_memo_id":{"title":"Credit Memo","type":"string"},"credit_usage_id":{"title":"Credit Usage","type":"string"},"customer_type":{"enum":["contact","organization"],"title":"Customer Type","type":"string"},"date":{"description":"The date of the batch","format":"date","title":"Date","type":"string"},"debit_memo_id":{"title":"Debit Memo","type":"string"},"fiscal_period":{"description":"The fiscal period of the batch","maximum":12,"minimum":1,"title":"Fiscal Period","type":"integer"},"fiscal_year_id":{"description":"The fiscal year of the business unit","title":"Fiscal Year","type":"string"},"gift_id":{"title":"Gift","type":"string"},"id":{"description":"A unique id for the entry","title":"ID","type":"string"},"inventory_receipt_id":{"title":"Inventory Receipt","type":"string"},"invoice_id":{"title":"Invoice","type":"string"},"items":{"items":{"additionalProperties":false,"properties":{"accounting_project_code":{"title":"Accounting Project Code","type":"string"},"accounting_project_id":{"title":"Accounting Project","type":"string"},"bank_account_id":{"title":"Bank Account","type":"string"},"credit_usage_line_item_id":{"title":"Credit Usage Line Item","type":"string"},"credits":{"format":"double","title":"Credits","type":"number"},"debits":{"format":"double","title":"Debits","type":"number"},"deferral_end_date":{"format":"date-time","title":"Deferral End Date","type":"string"},"deferral_start_date":{"format":"date-time","title":"Deferral Start Date","type":"string"},"department_code":{"title":"Department Code","type":"string"},"department_id":{"title":"Department","type":"string"},"due_to_due_from_business_unit_id":{"title":"Due To Due From Business Unit","type":"string"},"gl_account_code":{"title":"Gl Account Code","type":"string"},"gl_account_id":{"title":"Gl Account","type":"string"},"gl_account_name":{"title":"Gl Account Name","type":"string"},"invoice_id":{"title":"Invoice","type":"string"},"invoice_line_item_id":{"title":"Invoice Line Item","type":"string"},"merchant_account_id":{"title":"Merchant Account","type":"string"},"payment_line_item_id":{"title":"Payment Line Item","type":"string"},"product_id":{"title":"Product","type":"string"},"product_name":{"title":"Product Name","type":"string"},"product_type":{"title":"Product Type","type":"string"},"transaction_credits":{"format":"double","title":"Transaction Credits","type":"number"},"transaction_currency_code":{"enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHF","CLP","CNY","COP","CRC","CUC","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GQE","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZM","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SYP","SZL","THB","TJS","TMT","TND","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYU","UZS","VEB","VND","VUV","WST","XAF","XCD","XDR","XOF","XPF","YER","ZAR","ZMK","ZWR"],"title":"Transaction Currency Code","type":"string"},"transaction_debits":{"format":"double","title":"Transaction Debits","type":"number"},"type":{"enum":["accounts receivable","cash","cogs expense","credit expense","credit liability","credit usage","currency trading","deferred revenue","due to/due from","gift debit","gift revenue","inventory","invoice payment","overpayment","revenue","rounding","write off expense"],"title":"Type","type":"string"}},"required":["credits","debits","gl_account_code","gl_account_id","transaction_credits","transaction_currency_code","transaction_debits","type"],"type":"object"},"minItems":2,"type":"array"},"notes":{"title":"Notes","type":"string"},"order_date":{"title":"Order Date","type":"string"},"order_id":{"title":"Order","type":"string"},"organization_id":{"title":"Organization","type":"string"},"payment_card_type":{"description":"The tyep of card for payment","title":"Payment Card Type","type":"string"},"payment_id":{"title":"Payment","type":"string"},"payment_reference_number":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For payments, the reference or check #"},"children":[]}]}]}],"title":"Payment Reference Number","type":"string"},"payment_type":{"description":"The payment type","title":"Payment Type","type":"string"},"refund_id":{"title":"Refund","type":"string"},"revenue_recognition_schedule_entry_id":{"title":"Revenue Recognition Schedule Entry","type":"string"},"revenue_recognition_schedule_id":{"title":"Revenue Recognition Schedule","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"transaction_date":{"title":"Transaction Date","type":"string"},"transaction_id":{"title":"Transaction","type":"string"},"transaction_type":{"title":"Transaction Type","type":"string"},"write_off_id":{"title":"Write Off","type":"string"}},"required":["batch_id","business_unit_id","date","fiscal_period","fiscal_year_id","id","items","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id"],"type":"object"}},"components/schemas/WriteOff":{"id":"components/schemas/WriteOff","kind":"json-schema","title":"WriteOff","data":{"additionalProperties":false,"properties":{"bad_debts_expense_gl_account_id":{"description":"Bad debts expense GL account, required for allowance method","title":"Bad Debts Expense Gl Account","type":"string"},"base_currency_code":{"description":"The base currency for transactions business unit","maxLength":3,"minLength":3,"title":"Base Currency Code","type":"string"},"base_currency_symbol":{"description":"The base symbol for the transactions business unit","title":"Base Currency Symbol","type":"string"},"batch_id":{"description":"The batch this transaction belongs to","title":"Batch","type":"string"},"business_unit_id":{"description":"The business unit this transaction belongs to","title":"Business Unit","type":"string"},"cancellation_id":{"description":"The order cancellation tied to this transaction","title":"Cancellation","type":"string"},"currency_code":{"description":"The currency code in use","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHF","CLP","CNY","COP","CRC","CUC","CVE","CZK","DJF","DKK","DOP","DZD","EEK","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GQE","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZM","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SYP","SZL","THB","TJS","TMT","TND","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYU","UZS","VEB","VND","VUV","WST","XAF","XCD","XDR","XOF","XPF","YER","ZAR","ZMK","ZWR"],"maxLength":3,"minLength":3,"title":"Currency Code","type":"string"},"currency_symbol":{"description":"The currency symbol","title":"Currency Symbol","type":"string"},"custom_field_values":{"items":{"$ref":"#/components/schemas/CustomFieldValue"},"title":"Custom Field Values","type":"array"},"date":{"description":"The date of the transaction","format":"date","title":"Date","type":"string"},"exchange_rate":{"description":"The exchange rate, if applicable","format":"double","title":"Exchange Rate","type":"number"},"id":{"description":"The unique, string identifier of this write off","pattern":"^[\\w|-]+$","title":"ID","type":"string"},"invoice_id":{"description":"The invoice the write off applies to","title":"Invoice","type":"string"},"line_items":{"items":{"additionalProperties":false,"oneOf":[{"type":"object","properties":{"total_in_base_currency":{}},"required":["total_in_base_currency"],"additionalProperties":false}],"properties":{"description":{"description":"Descriptive information","title":"Description","type":"string"},"invoice_line_item_id":{"description":"The invoice line item being modified","title":"Invoice Line Item","type":"string"},"product_id":{"description":"The id of the product","title":"Product","type":"string"},"product_type":{"description":"The type of product","title":"Product Type","type":"string"},"total":{"description":"Total of the line item","format":"double","title":"Total","type":"number"},"total_in_base_currency":{"description":"The total of the transaction, in the base currency of the business unit.","format":"double","title":"Total In Base Currency","type":"number"}},"required":["invoice_line_item_id","product_id","product_type","total"],"type":"object"},"minItems":1,"type":"array"},"memo":{"description":"Memo/description of the transaction","title":"Memo","type":"string"},"method":{"description":"The mechanism for completing the write off","enum":["allowance","direct"],"title":"Method","type":"string"},"notes":{"description":"Notes fro the transaction","title":"Notes","type":"string"},"number":{"description":"The transaction number","title":"Number","type":"integer"},"order_id":{"description":"The order tied to this transaction","title":"Order","type":"string"},"return_id":{"description":"The return tied to this transaction","title":"Return","type":"string"},"sys_bulk_load_at":{"description":"If this record was loaded via bulk, the timestamp when the record was processed","title":"Sys Bulk Load At","type":"string"},"sys_bulk_load_id":{"description":"If this record was loaded via bulk, the ID of the bulk load process","title":"Sys Bulk Load","type":"string"},"sys_bulk_load_pk":{"description":"If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key","title":"Sys Bulk Load Pk","type":"string"},"sys_bulk_load_record_no":{"description":"If this record was loaded via bulk, the record number in the source file","format":"float","title":"Sys Bulk Load Record No","type":"number"},"sys_bulk_load_source_file":{"description":"If this record was loaded via bulk, the source file","title":"Sys Bulk Load Source File","type":"string"},"sys_calculated_field_error":{"description":"The error associated with the calculated field","title":"Sys Calculated Field Error","type":"string"},"sys_calculated_field_errors":{"items":{"additionalProperties":false,"properties":{"error":{"title":"Error","type":"string"},"field":{"title":"Field","type":"string"}},"type":"object"},"type":"array"},"sys_configuration_snapshot_id":{"description":"If a snapshot was restored/applies to this record, the ID of the snapshot","title":"Sys Configuration Snapshot","type":"string"},"sys_created_at":{"description":"The date/time that this record was created, expressed in ISO-8601 date format","format":"date-time","title":"Sys Created At","type":"string"},"sys_created_by_id":{"description":"The ID of the user that created this record","title":"Sys Created By","type":"string"},"sys_deleted_by_id":{"description":"The ID of the user that deleted (or last tried to delete) this object","title":"Sys Deleted By","type":"string"},"sys_directive":{"description":"Means for passing directive information into an object processing logic","title":"Sys Directive","type":"string"},"sys_external_id":{"description":"The ID that a record has from an external system or data import","title":"Sys External","type":"string"},"sys_has_files_in_s3":{"description":"If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion","title":"Sys Has Files In S3","type":"boolean"},"sys_last_bulk_data_operation_id":{"description":"If this record was last touched by a bulk data operation, the ID of that operation","title":"Sys Last Bulk Data Operation","type":"string"},"sys_last_bulk_data_operation_sys_version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If this record was last touched by a bulk data operation, the sys_version at the time of that operation"},"children":[]}]}]}],"title":"Sys Last Bulk Data Operation Sys Version","type":"string"},"sys_last_modified_at":{"description":"The date/time that this record record was last modified, expressed in ISO-8601 date format","format":"date-time","title":"Sys Last Modified At","type":"string"},"sys_last_modified_by_id":{"description":"The ID of the user that last modified this record","title":"Sys Last Modified By","type":"string"},"sys_last_security_context":{"description":"The security context of the last insert, modify, or delete performed on this item","properties":{},"title":"Sys Last Security Context","type":"object"},"sys_locked":{"description":"If set, this record is locked and cannot be changed via the API","title":"Sys Locked","type":"boolean"},"sys_search_composite_key":{"description":"Internal use","title":"Sys Search Composite Key","type":"string"},"sys_snapshot_base_version":{"description":"The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox","format":"float","title":"Sys Snapshot Base Version","type":"number"},"sys_version":{"description":"A number representing the version of this record in the database","format":"float","title":"Sys Version","type":"number"},"total":{"description":"The transaction total","format":"double","title":"Total","type":"number"},"total_in_base_currency":{"description":"The total of the transaction, in the base currency of the business unit.","format":"double","title":"Total In Base Currency","type":"number"},"workflow_execution_id":{"description":"The ID of the state machine execution used to create this transaction","title":"Workflow Execution","type":"string"}},"required":["batch_id","business_unit_id","id","invoice_id","line_items","method","number","sys_created_at","sys_created_by_id","sys_last_modified_at","sys_last_modified_by_id","total","total_in_base_currency"],"type":"object"}},"components/schemas/WriteOffSearchParameters":{"id":"components/schemas/WriteOffSearchParameters","kind":"json-schema","title":"WriteOffSearchParameters","data":{"additionalProperties":false,"properties":{"batch_id":{"items":{"type":"string"},"title":"Batch","type":"array"},"business_unit_id":{"description":"The business unit","title":"Business Unit","type":"string"},"date":{"items":{"type":"string"},"maxItems":2,"minItems":2,"title":"Date","type":"array"},"id":{"items":{"type":"string"},"title":"ID","type":"array"},"number":{"items":{"format":"float","type":"number"},"maxItems":2,"minItems":2,"title":"Number","type":"array"},"total":{"items":{"format":"float","type":"number"},"maxItems":2,"minItems":2,"title":"Total","type":"array"},"total_in_base_currency":{"items":{"format":"float","type":"number"},"maxItems":2,"minItems":2,"title":"Total In Base Currency","type":"array"}},"required":["business_unit_id"],"type":"object"}},"components/schemas/WriteOffSearchResults":{"id":"components/schemas/WriteOffSearchResults","kind":"json-schema","title":"WriteOffSearchResults","data":{"additionalProperties":false,"properties":{"base_currency_symbol":{"title":"Base Currency Symbol","type":"string"},"batch_id":{"title":"Batch","type":"string"},"business_unit_id":{"description":"The business unit","title":"Business Unit","type":"string"},"currency_symbol":{"title":"Currency Symbol","type":"string"},"date":{"title":"Date","type":"string"},"id":{"title":"ID","type":"string"},"number":{"format":"float","title":"Number","type":"number"},"total":{"format":"float","title":"Total","type":"number"},"total_in_base_currency":{"format":"float","title":"Total In Base Currency","type":"number"}},"required":["business_unit_id"],"type":"object"}},"schema_409":{"kind":"json-schema","data":{"type":"string"},"id":"schema_409"},"schema_410":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/AccountingProject"},"type":"array"},"id":"schema_410"},"schema_411":{"kind":"json-schema","data":{"type":"object","properties":{"Access-Control-Allow-Headers":{"type":"string"},"Access-Control-Allow-Methods":{"type":"string"},"Access-Control-Allow-Origin":{"type":"string"}}},"id":"schema_411"},"schema_412":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/PatchDirective"},"type":"array"},"id":"schema_412"},"schema_413":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/BankAccount"},"type":"array"},"id":"schema_413"},"schema_414":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/BatchAssignmentSetting"},"type":"array"},"id":"schema_414"},"schema_415":{"kind":"json-schema","data":{"type":"object"},"id":"schema_415"},"schema_416":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/BatchTemplate"},"type":"array"},"id":"schema_416"},"schema_417":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/Batch"},"type":"array"},"id":"schema_417"},"schema_418":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/BillingNotice"},"type":"array"},"id":"schema_418"},"schema_419":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/BillingTemplate"},"type":"array"},"id":"schema_419"},"schema_420":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/BusinessUnit"},"type":"array"},"id":"schema_420"},"schema_421":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/CheckRequestProcess"},"type":"array"},"id":"schema_421"},"schema_422":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/CheckRequestTemplate"},"type":"array"},"id":"schema_422"},"schema_423":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/CheckRequest"},"type":"array"},"id":"schema_423"},"schema_424":{"kind":"json-schema","data":{"type":"integer"},"id":"schema_424"},"schema_425":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/CogsEntry"},"type":"array"},"id":"schema_425"},"schema_426":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/CreditMemo"},"type":"array"},"id":"schema_426"},"schema_427":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/Credit"},"type":"array"},"id":"schema_427"},"schema_428":{"kind":"json-schema","data":{"type":"boolean"},"id":"schema_428"},"schema_429":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/CurrencyMappingPolicy"},"type":"array"},"id":"schema_429"},"schema_430":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/DebitMemo"},"type":"array"},"id":"schema_430"},"schema_431":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/Department"},"type":"array"},"id":"schema_431"},"schema_432":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/DonationProduct"},"type":"array"},"id":"schema_432"},"schema_433":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/ExchangeRate"},"type":"array"},"id":"schema_433"},"schema_434":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/FiscalYear"},"type":"array"},"id":"schema_434"},"schema_435":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/FiscalYearAndPeriod"},"type":"array"},"id":"schema_435"},"schema_436":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/GlAccount"},"type":"array"},"id":"schema_436"},"schema_437":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/InstallmentPlan"},"type":"array"},"id":"schema_437"},"schema_438":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/InstallmentSchedule"},"type":"array"},"id":"schema_438"},"schema_439":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/InvoicePaymentTerm"},"type":"array"},"id":"schema_439"},"schema_440":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/InvoiceTemplate"},"type":"array"},"id":"schema_440"},"schema_441":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/InvoiceType"},"type":"array"},"id":"schema_441"},"schema_442":{"kind":"json-schema","data":{"properties":{"email":{"type":"string"},"template":{"type":"string"}},"type":"object"},"id":"schema_442"},"schema_443":{"kind":"json-schema","data":{"type":"number"},"id":"schema_443"},"schema_444":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/LateFeeRule"},"type":"array"},"id":"schema_444"},"schema_445":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/LateFee"},"type":"array"},"id":"schema_445"},"schema_446":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/LegacyImportProduct"},"type":"array"},"id":"schema_446"},"schema_447":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/MerchantAccount"},"type":"array"},"id":"schema_447"},"schema_448":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/MiscellaneousProduct"},"type":"array"},"id":"schema_448"},"schema_449":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/PaymentReceiptTemplate"},"type":"array"},"id":"schema_449"},"schema_450":{"kind":"json-schema","data":{"properties":{"memo":{"type":"string"}},"type":"object"},"id":"schema_450"},"schema_451":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/ProductFinancialConfig"},"type":"array"},"id":"schema_451"},"schema_452":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/RecurringBatch"},"type":"array"},"id":"schema_452"},"schema_453":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/RecurringBillingRun"},"type":"array"},"id":"schema_453"},"schema_454":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/RefundReceiptTemplate"},"type":"array"},"id":"schema_454"},"schema_455":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/Refund"},"type":"array"},"id":"schema_455"},"schema_456":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/RevenueRecognitionSchedule"},"type":"array"},"id":"schema_456"},"schema_457":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/StatementTemplate"},"type":"array"},"id":"schema_457"},"schema_458":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/WriteOff"},"type":"array"},"id":"schema_458"}},"exampleStore":{},"securitySchemeStore":{"knox-authorizer":{"id":"knox-authorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}},"servers":[{"url":"/_mock/apis/collect/collect-v1","isMockServer":true,"description":"Mock server"},{"url":"https://collect.api.rhythmsoftware.com"}],"specType":"openapi"},"options":{"mockServer":{"url":"/_mock/apis/collect/collect-v1","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/apis/collect/collect-v1.json?download"},{"url":"/_bundle/apis/collect/collect-v1.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Collect (Finance & Billing)","description":"The Finance, or Collect, API provides all the accounts receivable capabilities in Rhythm. This includes all aspects of \nInvoices, Credits, Payments, Credit Memos, and Debit Memos. Additionally, this API manages Batches and Fiscal Periods \nand can be used to download batches for import into your accounting package.\n\nLike most of the other Rhythm apps, the Collect API includes endpoints for Query Definitions. These endpoints are commonly\nused to retrieve saved queries, which can then be executed using the Query endpoints of the System API. \n"}},"baseSlug":"/apis/collect/collect-v1","routesMapping":{}}