{
  "opencollection": "1.0.0",
  "info": {
    "name": "Yokoy Card account Invoice API",
    "version": "1.41.0"
  },
  "items": [
    {
      "info": {
        "name": "Invoice",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List all invoices",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.yokoy.ai/v1/organizations/{organizationId}/legal-entities/:legalEntityId/invoices",
            "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."
              },
              {
                "name": "count",
                "value": "30",
                "type": "query",
                "description": "Optional count for paginating. When provided, the results are paginated. Without `count`, no pagination is provided.\nThe maximum number of items that can be included in a paginated response is `100`.\nWhen paginated, the response includes the `itemsPerPage` attribute.\nIf the number of items available is greater than or equal to `count`, it also includes the `nextCursor` attribute, which can be used to fetch the subsequent page of items.\n"
              },
              {
                "name": "cursor",
                "value": "06x2u4nagAMEq3gGMoch",
                "type": "query",
                "description": "Optional cursor for paginating. When provided, the API fetches a subsequent page of items.\nThe subsequent page is identified by the value given in `nextCursor` in the previous response.\n`cursor` can only be used if the `count` attribute is passed as a query parameter.\n"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://accounts[.test].yokoy.ai/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Retrieves all invoices for the legal entity identified in the path."
        },
        {
          "info": {
            "name": "Create an invoice",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.yokoy.ai/v1/organizations/{organizationId}/legal-entities/:legalEntityId/invoices",
            "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 and returns the created entity."
        },
        {
          "info": {
            "name": "Upload a new e-invoice to Yokoy",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.yokoy.ai/v1/organizations/{organizationId}/legal-entities/:legalEntityId/invoices/einvoice",
            "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": "multipart-form",
              "data": [
                {
                  "name": "invoiceData",
                  "type": "text",
                  "value": ""
                },
                {
                  "name": "pdf",
                  "type": "text",
                  "value": ""
                },
                {
                  "name": "standard",
                  "type": "text",
                  "value": ""
                }
              ]
            },
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://accounts[.test].yokoy.ai/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Uploads a new e-invoice for the legal entity specified by its Yokoy unique ID and returns the details for the created invoice.\n"
        },
        {
          "info": {
            "name": "Upload a new invoice to be processed by Yokoy AI",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.yokoy.ai/v1/organizations/{organizationId}/legal-entities/:legalEntityId/invoices/upload",
            "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": "multipart-form",
              "data": [
                {
                  "name": "file",
                  "type": "text",
                  "value": ""
                }
              ]
            },
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://accounts[.test].yokoy.ai/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Uploads a new invoice to be processed by the Yokoy AI. The invoice‘s attributes may be empty initially but are updated once the AI has run.\n"
        },
        {
          "info": {
            "name": "Get an invoice",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.yokoy.ai/v1/organizations/{organizationId}/legal-entities/:legalEntityId/invoices/:invoiceId",
            "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": "invoiceId",
                "value": "9L7rovNzNhTCsJSTkbfq",
                "type": "path",
                "description": "Yokoy unique ID of the invoice."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://accounts[.test].yokoy.ai/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Retrieves an invoice identified by its Yokoy unique ID."
        },
        {
          "info": {
            "name": "Update an invoice",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.yokoy.ai/v1/organizations/{organizationId}/legal-entities/:legalEntityId/invoices/:invoiceId",
            "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": "invoiceId",
                "value": "9L7rovNzNhTCsJSTkbfq",
                "type": "path",
                "description": "Yokoy unique ID of the invoice."
              }
            ],
            "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 identified by its Yokoy unique ID."
        },
        {
          "info": {
            "name": "Get the invoice PDF file (base64)",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.yokoy.ai/v1/organizations/{organizationId}/legal-entities/:legalEntityId/invoices/:invoiceId/base64",
            "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": "invoiceId",
                "value": "9L7rovNzNhTCsJSTkbfq",
                "type": "path",
                "description": "Yokoy unique ID of the invoice."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://accounts[.test].yokoy.ai/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Retrieves the supplier invoice PDF file. The response contains a base64 string of the PDF file.\n"
        },
        {
          "info": {
            "name": "Get the invoice file in PDF format",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.yokoy.ai/v1/organizations/{organizationId}/legal-entities/:legalEntityId/invoices/:invoiceId/presentation",
            "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": "invoiceId",
                "value": "9L7rovNzNhTCsJSTkbfq",
                "type": "path",
                "description": "Yokoy unique ID of the invoice."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "https://accounts[.test].yokoy.ai/oauth2/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Downloads the supplier invoice file in PDF format\n"
        }
      ]
    }
  ],
  "bundled": true
}