{ "opencollection": "1.0.0", "info": { "name": "Yokoy Card account Invoice category API", "version": "1.41.0" }, "items": [ { "info": { "name": "Invoice category", "type": "folder" }, "items": [ { "info": { "name": "List all invoice categories", "type": "http" }, "http": { "method": "GET", "url": "https://api.yokoy.ai/v1/organizations/{organizationId}/legal-entities/:legalEntityId/invoice-categories", "headers": [ { "name": "X-Yk-Auth-Method", "value": "yokoy" }, { "name": "X-Yk-Correlation-Id", "value": "4ea8985e-80a2-40a0-8a40-401a1a1374b3" } ], "params": [ { "name": "legalEntityId", "value": "aB9jQoE3HE", "type": "path", "description": "Yokoy unique ID of the legal entity (company)." }, { "name": "filter", "value": "created ge 2024-03-02T09:00.000Z and customInformation.customField eq foo", "type": "query", "description": "Filter string used to restrict the data returned. You can use [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.4.2.2) filters." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://accounts[.test].yokoy.ai/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves all invoice categories for the legal entity identified in the path." }, { "info": { "name": "Create an invoice category", "type": "http" }, "http": { "method": "POST", "url": "https://api.yokoy.ai/v1/organizations/{organizationId}/legal-entities/:legalEntityId/invoice-categories", "headers": [ { "name": "X-Yk-Auth-Method", "value": "yokoy" }, { "name": "X-Yk-Correlation-Id", "value": "4ea8985e-80a2-40a0-8a40-401a1a1374b3" } ], "params": [ { "name": "legalEntityId", "value": "aB9jQoE3HE", "type": "path", "description": "Yokoy unique ID of the legal entity (company)." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://accounts[.test].yokoy.ai/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a new invoice category and returns the created entity." }, { "info": { "name": "Get an invoice category by ID", "type": "http" }, "http": { "method": "GET", "url": "https://api.yokoy.ai/v1/organizations/{organizationId}/legal-entities/:legalEntityId/invoice-categories/:categoryId", "headers": [ { "name": "X-Yk-Auth-Method", "value": "yokoy" }, { "name": "X-Yk-Correlation-Id", "value": "4ea8985e-80a2-40a0-8a40-401a1a1374b3" } ], "params": [ { "name": "legalEntityId", "value": "aB9jQoE3HE", "type": "path", "description": "Yokoy unique ID of the legal entity (company)." }, { "name": "categoryId", "value": "hm0qUnb8s", "type": "path", "description": "Yokoy unique ID of the invoice category." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://accounts[.test].yokoy.ai/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieves an invoice category identified by its Yokoy unique ID." }, { "info": { "name": "Update an invoice category", "type": "http" }, "http": { "method": "PUT", "url": "https://api.yokoy.ai/v1/organizations/{organizationId}/legal-entities/:legalEntityId/invoice-categories/:categoryId", "headers": [ { "name": "X-Yk-Auth-Method", "value": "yokoy" }, { "name": "X-Yk-Correlation-Id", "value": "4ea8985e-80a2-40a0-8a40-401a1a1374b3" } ], "params": [ { "name": "legalEntityId", "value": "aB9jQoE3HE", "type": "path", "description": "Yokoy unique ID of the legal entity (company)." }, { "name": "categoryId", "value": "hm0qUnb8s", "type": "path", "description": "Yokoy unique ID of the invoice category." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://accounts[.test].yokoy.ai/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates an invoice category by replacing all attributes. The whole entity is returned." }, { "info": { "name": "Modify an invoice category", "type": "http" }, "http": { "method": "PATCH", "url": "https://api.yokoy.ai/v1/organizations/{organizationId}/legal-entities/:legalEntityId/invoice-categories/:categoryId", "headers": [ { "name": "X-Yk-Auth-Method", "value": "yokoy" }, { "name": "X-Yk-Correlation-Id", "value": "4ea8985e-80a2-40a0-8a40-401a1a1374b3" } ], "params": [ { "name": "legalEntityId", "value": "aB9jQoE3HE", "type": "path", "description": "Yokoy unique ID of the legal entity (company)." }, { "name": "categoryId", "value": "hm0qUnb8s", "type": "path", "description": "Yokoy unique ID of the invoice category." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://accounts[.test].yokoy.ai/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates an invoice category by replacing some attributes. The whole entity is returned." } ] } ], "bundled": true }