{
  "opencollection": "1.0.0",
  "info": {
    "name": "Octobat Coupons Invoices API",
    "version": "2.0"
  },
  "request": {
    "auth": {
      "type": "basic",
      "username": "{{username}}",
      "password": "{{password}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Invoices",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List invoices",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://apiv2.octobat.com/invoices",
            "params": [
              {
                "name": "customer",
                "value": "",
                "type": "query",
                "description": "Filter by customer ID."
              },
              {
                "name": "status",
                "value": "",
                "type": "query",
                "description": "Filter by invoice status (use \"due\" for unpaid invoices)."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Lists invoices. Supports filtering by customer and by status, including due / unpaid invoices, via query parameters."
        },
        {
          "info": {
            "name": "Create an invoice",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://apiv2.octobat.com/invoices",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new invoice for a customer. (Confirmed in Octobat docs.)"
        },
        {
          "info": {
            "name": "Retrieve an invoice",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://apiv2.octobat.com/invoices/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Retrieve an invoice"
        },
        {
          "info": {
            "name": "Update an invoice",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://apiv2.octobat.com/invoices/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update an invoice"
        },
        {
          "info": {
            "name": "Delete an invoice",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://apiv2.octobat.com/invoices/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Delete an invoice"
        },
        {
          "info": {
            "name": "Add an item to an invoice",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://apiv2.octobat.com/invoices/:id/items",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Adds a line item to an invoice. Provide a tax_evidence ID (from the Tax Evidence API) or explicit tax parameters. (Confirmed in Octobat docs.)"
        },
        {
          "info": {
            "name": "Confirm (finalize) an invoice",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://apiv2.octobat.com/invoices/:id/confirm",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Confirms an invoice, assigning it a sequential legal number and making it immutable. (Confirmed in Octobat docs.)"
        },
        {
          "info": {
            "name": "Send an invoice by email",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://apiv2.octobat.com/invoices/:id/send",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Send an invoice by email"
        },
        {
          "info": {
            "name": "Set payment terms on an invoice",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://apiv2.octobat.com/invoices/:id/set_payment_terms",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Set payment terms on an invoice"
        },
        {
          "info": {
            "name": "Mark an invoice uncollectible",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://apiv2.octobat.com/invoices/:id/mark_uncollectible",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Mark an invoice uncollectible"
        },
        {
          "info": {
            "name": "Cancel an invoice",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://apiv2.octobat.com/invoices/:id/cancel",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Cancel an invoice"
        },
        {
          "info": {
            "name": "Cancel and replace an invoice",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://apiv2.octobat.com/invoices/:id/cancel_and_replace",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Cancel and replace an invoice"
        },
        {
          "info": {
            "name": "Export invoices to PDF",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://apiv2.octobat.com/invoices/pdf_export"
          },
          "docs": "Export invoices to PDF"
        },
        {
          "info": {
            "name": "Export invoices to CSV",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://apiv2.octobat.com/invoices/csv_export"
          },
          "docs": "Export invoices to CSV"
        }
      ]
    }
  ],
  "bundled": true
}