{ "opencollection": "1.0.0", "info": { "name": "API Reference Accounting Codes Actions API", "version": "2023-12-15" }, "items": [ { "info": { "name": "Actions", "type": "folder" }, "items": [ { "info": { "name": "Create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/action/create", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "X-Zuora-WSDL-Version", "value": "" } ], "params": [ { "name": "rejectUnknownFields", "value": "", "type": "query", "description": "Specifies whether the call fails if the request body contains unknown fields.\nWith `rejectUnknownFields` set to `true`, Zuora returns a 400 response if\nthe request body contains unknown fields. The body of the 400 response is:\n\n```json\n{\n \"message\": \"Error - unrecognised fields\"\n}\n```\n\nBy default, Zuora ignores unknown fields in the request body.\n" } ] }, "docs": "Use the create call to create one or more objects of a specific type. You can specify different types in different create calls, but each create call must apply to only one type of object.\n\n### Limitations \n\nThis call has the following limitations:\n\n* A maximum of 50 objects are supported in a single call.\n* The Orders feature is not supported.\n* The Invoice Settlement feature is not supported. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement.\n* The de" }, { "info": { "name": "Delete", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/action/delete", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "X-Zuora-WSDL-Version", "value": "" } ], "params": [ { "name": "rejectUnknownFields", "value": "", "type": "query", "description": "Specifies whether the call fails if the request body contains unknown fields.\nWith `rejectUnknownFields` set to `true`, Zuora returns a 400 response if\nthe request body contains unknown fields. The body of the 400 response is:\n\n```json\n{\n \"message\": \"Error - unrecognised fields\"\n}\n```\n\nBy default, Zuora ignores unknown fields in the request body.\n" } ] }, "docs": "Deletes one or more objects of the same type. You can specify different types in different delete calls, but each delete call must apply only to one type of object.\n\nThe following information applies to this call:\n\n* You will need to first determine the IDs for the objects you wish to delete.\n* You cannot pass in any null IDs.\n* All objects in a specific delete call must be of the same type.\n\n\n### Objects per Call\n50 objects are supported in a single call.\n" }, { "info": { "name": "Query", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/action/query", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "X-Zuora-WSDL-Version", "value": "" } ], "params": [ { "name": "rejectUnknownFields", "value": "", "type": "query", "description": "Specifies whether the call fails if the request body contains unknown fields.\nWith `rejectUnknownFields` set to `true`, Zuora returns a 400 response if\nthe request body contains unknown fields. The body of the 400 response is:\n\n```json\n{\n \"message\": \"Error - unrecognised fields\"\n}\n```\n\nBy default, Zuora ignores unknown fields in the request body.\n" } ] }, "docs": "The query call sends a query expression by specifying the object to query, the fields to retrieve from that object, and any filters to determine whether a given object should be queried.\n\n\nYou can use [Zuora Object Query Language](https://knowledgecenter.zuora.com/DC_Developers/K_Zuora_Object_Query_Language) (ZOQL) to construct those queries, passing them through the `queryString`.\n\n\nOnce the call is made, the API executes the query against the specified object and returns a query response objec" }, { "info": { "name": "QueryMore", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/action/queryMore", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "X-Zuora-WSDL-Version", "value": "" } ], "params": [ { "name": "rejectUnknownFields", "value": "", "type": "query", "description": "Specifies whether the call fails if the request body contains unknown fields.\nWith `rejectUnknownFields` set to `true`, Zuora returns a 400 response if\nthe request body contains unknown fields. The body of the 400 response is:\n\n```json\n{\n \"message\": \"Error - unrecognised fields\"\n}\n```\n\nBy default, Zuora ignores unknown fields in the request body.\n" } ] }, "docs": "Use queryMore to request additional results from a previous query call. If your initial query call returns more than 2000 results, you can use queryMore to query for the additional results.\n\n\nAny `queryLocator` results greater than 2,000, will only be stored by Zuora for 5 days before it is deleted.\n\n\n This call sends a request for additional results from an initial query call. If the initial query call returns more than 2000 results, you can use the `queryLocator` returned from query to request" }, { "info": { "name": "Update", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/action/update", "headers": [ { "name": "Idempotency-Key", "value": "" }, { "name": "Accept-Encoding", "value": "" }, { "name": "Content-Encoding", "value": "" }, { "name": "Authorization", "value": "" }, { "name": "Zuora-Entity-Ids", "value": "" }, { "name": "Zuora-Org-Ids", "value": "" }, { "name": "Zuora-Track-Id", "value": "" }, { "name": "X-Zuora-WSDL-Version", "value": "" } ], "params": [ { "name": "rejectUnknownFields", "value": "", "type": "query", "description": "Specifies whether the call fails if the request body contains unknown fields.\nWith `rejectUnknownFields` set to `true`, Zuora returns a 400 response if\nthe request body contains unknown fields. The body of the 400 response is:\n\n```json\n{\n \"message\": \"Error - unrecognised fields\"\n}\n```\n\nBy default, Zuora ignores unknown fields in the request body.\n" } ] }, "docs": "\nUpdates the information in one or more objects of the same type. You can specify different types of objects in different update calls, but each specific update call must apply to only one type of object.\n\n\n### Limitations \n\nThis call has the following limitations:\n\n* A maximum of 50 objects are supported in a single call.\n* The Invoice Settlement feature is not supported. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement.\n* The default WSDL version for" } ] } ], "bundled": true }