> ## Documentation Index
> Fetch the complete documentation index at: https://docs.restaurant365.com/llms.txt
> Use this file to discover all available pages before exploring further.

# AP Payments

> Retrieves payments. If no filter of any kind is supplied, results are limited to the current day (UTC).

**Security**

The requesting user must have the following permission to retrieve AP payments:

- Accounts Payable → AP Payments → View AP Payments

_Restricted-record access:_ the response excludes records that reference a restricted GL account or a restricted vendor unless the user also has:

- General Ledger → GL Accounts → Access Restricted GL Accounts
- Accounts Payable → Vendors → Access Restricted Vendors

## OpenAPI

````json GET /public/v1/accounting/accounts-payable/payments
{
  "openapi": "3.0.1",
  "info": {
    "title": "R365 Public API",
    "contact": {
      "name": "R365 Services Team",
      "email": "r365@restaurant365.com"
    },
    "version": "1.0"
  },
  "security": [
    {
      "Bearer": []
    }
  ],
  "paths": {
    "/public/v1/accounting/accounts-payable/payments": {
      "get": {
        "tags": [
          "accounting"
        ],
        "summary": "AP Payments",
        "description": "Retrieves payments. If no filter of any kind is supplied, results are limited to the current day (UTC).\n\n**Security**\n\nThe requesting user must have the following permission to retrieve AP payments:\n\n- Accounts Payable → AP Payments → View AP Payments\n\n_Restricted-record access:_ the response excludes records that reference a restricted GL account or a restricted vendor unless the user also has:\n\n- General Ledger → GL Accounts → Access Restricted GL Accounts\n- Accounts Payable → Vendors → Access Restricted Vendors",
        "parameters": [
          {
            "$ref": "#/components/parameters/TenantId"
          },
          {
            "name": "ModifiedOnStart",
            "in": "query",
            "description": "Modified date start (inclusive)",
            "required": false,
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "name": "ModifiedOnEnd",
            "in": "query",
            "description": "Modified date end (inclusive)",
            "required": false,
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "name": "DateStart",
            "in": "query",
            "description": "Payment date (GL posting date) start (inclusive).",
            "required": false,
            "schema": {
              "type": "string",
              "format": "date"
            }
          },
          {
            "name": "DateEnd",
            "in": "query",
            "description": "Payment date (GL posting date) end (inclusive).",
            "required": false,
            "schema": {
              "type": "string",
              "format": "date"
            }
          },
          {
            "name": "Status",
            "in": "query",
            "description": "Status. Valid values: Approved, Unapproved",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "PaymentNumbers",
            "in": "query",
            "description": "Payment numbers (comma-separated)",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "PaymentIds",
            "in": "query",
            "description": "Payment IDs (comma-separated UUIDs)",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "pageSize",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int32",
              "minimum": 1,
              "maximum": 250,
              "default": 250
            },
            "description": "Maximum number of top-level objects to return in one page."
          },
          {
            "name": "ContinuationToken",
            "in": "query",
            "description": "Continuation token for pagination. Use the nextLink from a previous response to get the next page of results",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Payment query results.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/QueryPaymentsResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request — a parameter value is malformed, of the wrong type, or outside its allowed range."
          },
          "401": {
            "description": "Unauthorized — the bearer token is missing, invalid or expired, or is not valid for the specified tenant."
          },
          "403": {
            "description": "Forbidden — the caller lacks the permission required for this operation."
          },
          "404": {
            "description": "Not Found — the requested resource does not exist, or the supplied continuation token is unknown or has expired."
          },
          "409": {
            "description": "Conflict — the request conflicts with the current state of the resource and cannot be applied."
          },
          "422": {
            "description": "Unprocessable Entity — a required parameter is missing, or a supplied parameter value is invalid."
          },
          "429": {
            "description": "Too Many Requests — the caller has exceeded the rate limit; retry after a short delay."
          },
          "500": {
            "description": "Internal Server Error — an unexpected error occurred while processing the request."
          }
        }
      }
    }
  },
  "components": {
    "parameters": {
      "TenantId": {
        "name": "x-r365-context-tenant-id",
        "in": "header",
        "required": true,
        "description": "Identifies the R365 tenant the request applies to. Required on every request.",
        "schema": {
          "type": "string"
        }
      }
    },
    "schemas": {
      "QueryPaymentsResponse": {
        "type": "object",
        "properties": {
          "payments": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Payment"
            },
            "description": "The collection of payments for the current page.",
            "nullable": true
          },
          "nextLink": {
            "type": "string",
            "description": "The URL to retrieve the next page of results, or null if this is the last page.",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "Paginated response containing queried payments."
      },
      "Payment": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Unique identifier (GUID) of the payment.",
            "format": "uuid"
          },
          "number": {
            "type": "string",
            "description": "Payment number.",
            "nullable": true
          },
          "location": {
            "$ref": "#/components/schemas/PaymentLocationReference"
          },
          "vendor": {
            "$ref": "#/components/schemas/PaymentVendorReference"
          },
          "date": {
            "type": "string",
            "description": "Date the payment was issued.",
            "format": "date",
            "nullable": true
          },
          "amount": {
            "type": "number",
            "description": "Total amount of the payment.",
            "format": "double"
          },
          "comment": {
            "type": "string",
            "description": "Free-text comment or memo on the payment.",
            "nullable": true
          },
          "status": {
            "type": "string",
            "description": "Approval status of the payment. Values are \"Approved\", \"Unapproved\".",
            "nullable": true
          },
          "checkingAccount": {
            "$ref": "#/components/schemas/PaymentGlAccountReference"
          },
          "appliedInvoices": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AppliedInvoiceReference"
            },
            "description": "Invoices applied to this payment, if any.",
            "nullable": true
          },
          "distributions": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PaymentDistributionLine"
            },
            "description": "GL distribution lines for this payment, included when IncludeDistributions is true in the request.",
            "nullable": true
          },
          "createdOn": {
            "type": "string",
            "description": "Timestamp when the payment was created.",
            "format": "date-time",
            "nullable": true
          },
          "createdBy": {
            "$ref": "#/components/schemas/PaymentUserReference",
            "description": "User who created the payment."
          },
          "modifiedOn": {
            "type": "string",
            "description": "Timestamp of the most recent modification.",
            "format": "date-time",
            "nullable": true
          },
          "modifiedBy": {
            "$ref": "#/components/schemas/PaymentUserReference",
            "description": "User who last modified the payment."
          },
          "approvedOn": {
            "type": "string",
            "description": "Timestamp when the payment was approved.",
            "format": "date-time",
            "nullable": true
          },
          "approvedBy": {
            "$ref": "#/components/schemas/PaymentUserReference",
            "description": "User who approved the payment."
          },
          "attachments": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PaymentTransactionAttachment"
            },
            "description": "Files attached to this payment.",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "Payment model for the query payments public API response."
      },
      "PaymentLocationReference": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Unique identifier (GUID) of the location.",
            "format": "uuid"
          },
          "name": {
            "type": "string",
            "description": "Display name of the location.",
            "nullable": true
          },
          "number": {
            "type": "string",
            "description": "Location number.",
            "nullable": true
          },
          "legalEntity": {
            "$ref": "#/components/schemas/PaymentLegalEntityReference"
          }
        },
        "additionalProperties": false,
        "description": "Location reference with optional legal entity."
      },
      "PaymentVendorReference": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Unique identifier (GUID) of the vendor.",
            "format": "uuid"
          },
          "name": {
            "type": "string",
            "description": "Vendor display name (check name).",
            "nullable": true
          },
          "number": {
            "type": "string",
            "description": "Vendor account number.",
            "nullable": true
          },
          "entryType": {
            "type": "string",
            "nullable": true,
            "enum": [
              "ByAccount",
              "ByItem"
            ],
            "description": "How the vendor's transactions are entered. Present on every payment."
          }
        },
        "additionalProperties": false,
        "description": "Vendor reference with id, name (CheckName), and number (AccountNumber)."
      },
      "PaymentGlAccountReference": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Unique identifier (GUID) of the GL account.",
            "format": "uuid"
          },
          "name": {
            "type": "string",
            "description": "Display name of the GL account.",
            "nullable": true
          },
          "number": {
            "type": "string",
            "description": "GL account number.",
            "nullable": true
          },
          "glType": {
            "type": "string",
            "description": "GL type name for this account.",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "GL Account reference."
      },
      "AppliedInvoiceReference": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Unique identifier (GUID) of the invoice.",
            "format": "uuid"
          },
          "invoiceNumber": {
            "type": "string",
            "description": "Invoice number.",
            "nullable": true
          },
          "appliedAmount": {
            "type": "number",
            "description": "Amount applied from this invoice toward the payment.",
            "format": "double"
          },
          "invoiceTotal": {
            "type": "number",
            "description": "Total amount of the invoice.",
            "format": "double"
          }
        },
        "additionalProperties": false,
        "description": "Reference to an invoice applied to a payment."
      },
      "PaymentDistributionLine": {
        "type": "object",
        "properties": {
          "glAccount": {
            "$ref": "#/components/schemas/PaymentGlAccountReference"
          },
          "debit": {
            "type": "number",
            "description": "Debit amount on this distribution line. Zero when the line is a credit.",
            "format": "double"
          },
          "credit": {
            "type": "number",
            "description": "Credit amount on this distribution line. Zero when the line is a debit.",
            "format": "double"
          },
          "comment": {
            "type": "string",
            "description": "Comment on this distribution line.",
            "nullable": true
          },
          "location": {
            "$ref": "#/components/schemas/PaymentLocationReference"
          }
        },
        "additionalProperties": false,
        "description": "A single GL distribution line for a posted transaction."
      },
      "PaymentUserReference": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Unique identifier (GUID) of the entity.",
            "format": "uuid"
          },
          "name": {
            "type": "string",
            "description": "Display name of the entity.",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "User reference."
      },
      "PaymentTransactionAttachment": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "Numeric identifier of the attachment.",
            "format": "int32"
          },
          "storageFileName": {
            "type": "string",
            "description": "Internal storage key or path for the file.",
            "nullable": true
          },
          "filename": {
            "type": "string",
            "description": "Original file name as uploaded.",
            "nullable": true
          },
          "linkType": {
            "type": "string",
            "description": "Link type indicating how the attachment is associated with the transaction.",
            "nullable": true
          },
          "publicUrl": {
            "type": "string",
            "description": "Public URL to download the full attachment.",
            "nullable": true
          },
          "publicThumbnailUrl": {
            "type": "string",
            "description": "Public URL for a thumbnail preview of the attachment, if available.",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "File attachment linked to an AP transaction."
      },
      "PaymentLegalEntityReference": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Unique identifier (GUID) of the legal entity.",
            "format": "uuid"
          },
          "name": {
            "type": "string",
            "description": "Display name of the legal entity.",
            "nullable": true
          },
          "number": {
            "type": "string",
            "description": "Legal entity number.",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "Legal entity reference."
      }
    },
    "securitySchemes": {
      "Bearer": {
        "type": "http",
        "scheme": "Bearer"
      }
    }
  }
}
````