{ "opencollection": "1.0.0", "info": { "name": "Togai Apis Accounts Invoices API", "version": "1.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Invoices", "type": "folder" }, "items": [ { "info": { "name": "List Invoices", "type": "http" }, "http": { "method": "GET", "url": "https://api.togai.com/invoices", "params": [ { "name": "nextToken", "value": "", "type": "query", "description": "Pagination token used as a marker to get records from next page." }, { "name": "status", "value": "", "type": "query", "description": "Filter option to filter by status." }, { "name": "owner_id", "value": "", "type": "query", "description": "Filter option to filter based on owner id." }, { "name": "customer_id", "value": "", "type": "query", "description": "Filter option to filter based on customer id." }, { "name": "pageSize", "value": "", "type": "query", "description": "Maximum page size expected by client to return the record list. \n\n NOTE: Max page size cannot be more than 50. Also 50 is the default page size if no value is provided." }, { "name": "start_time", "value": "", "type": "query", "description": "Start time filter in epoch milli seconds" }, { "name": "end_time", "value": "", "type": "query", "description": "End time filter in epoch milli seconds" } ] }, "docs": "List invoices" }, { "info": { "name": "Create a Custom Invoice for an Account", "type": "http" }, "http": { "method": "POST", "url": "https://api.togai.com/invoices", "body": { "type": "json", "data": "{}" } }, "docs": "Create a custom invoice for an account." }, { "info": { "name": "Get an Invoice", "type": "http" }, "http": { "method": "GET", "url": "https://api.togai.com/invoices/:invoice_id", "params": [ { "name": "invoice_id", "value": "", "type": "path" } ] }, "docs": "Get invoice" }, { "info": { "name": "Update an Invoice", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.togai.com/invoices/:invoice_id", "params": [ { "name": "invoice_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an invoice[Only CUSTOM invoices in DRAFT state support updating of all fields]. Updating status can be done for all invoice." }, { "info": { "name": "Delete a Custom Invoice in DRAFT State", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.togai.com/invoices/:invoice_id", "params": [ { "name": "invoice_id", "value": "", "type": "path" } ] }, "docs": "Delete a custom invoice in DRAFT state." }, { "info": { "name": "List Invoices Eligible for Bill Run", "type": "http" }, "http": { "method": "GET", "url": "https://api.togai.com/invoices/bill_runs", "params": [ { "name": "nextToken", "value": "", "type": "query", "description": "Pagination token used as a marker to get records from next page." }, { "name": "status", "value": "", "type": "query", "description": "Filter option to filter by status." }, { "name": "owner_id", "value": "", "type": "query", "description": "Filter option to filter based on owner id." }, { "name": "customer_id", "value": "", "type": "query", "description": "Filter option to filter based on customer id." }, { "name": "pageSize", "value": "", "type": "query", "description": "Maximum page size expected by client to return the record list. \n\n NOTE: Max page size cannot be more than 50. Also 50 is the default page size if no value is provided." }, { "name": "start_time", "value": "", "type": "query", "description": "Start time filter in epoch milli seconds" }, { "name": "end_time", "value": "", "type": "query", "description": "End time filter in epoch milli seconds" } ] }, "docs": "List invoices eligible for bill run" }, { "info": { "name": "Create a Bill Run Job Request", "type": "http" }, "http": { "method": "POST", "url": "https://api.togai.com/invoices/bill_runs", "params": [ { "name": "require_confirmation", "value": "", "type": "query", "description": "Specifies whether to start a migration only after a confirmation" } ] }, "docs": "Create a bill run job request" }, { "info": { "name": "Add or Update Miscellaneous Charges in Invoice", "type": "http" }, "http": { "method": "PUT", "url": "https://api.togai.com/invoices/:invoice_id/miscellaneous_charges", "params": [ { "name": "invoice_id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add or update miscellaneous charges in Invoice" }, { "info": { "name": "Add or Update Miscellaneous Charges in Upcoming Invoice for a Account", "type": "http" }, "http": { "method": "PUT", "url": "https://api.togai.com/accounts/:account_id/miscellaneous_charges", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "account_id corresponding to an account" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add or update miscellaneous charges in upcoming Invoice for a account" }, { "info": { "name": "List Pricing Rule Logs", "type": "http" }, "http": { "method": "GET", "url": "https://api.togai.com/invoice/:invoice_id/pricing_rules_logs", "params": [ { "name": "invoice_id", "value": "", "type": "path" } ] }, "docs": "List pricing rule logs" } ] } ], "bundled": true }