RIrillet
Vendor Credits

Lists all vendor credits

Changed on

Returns vendor credits with pagination and filters for vendor, subsidiary, and freshness. Credits represent vendor-issued balance reductions you can later apply to bills using apply-vendor-credit.

get/vendor-credits

Request

Query parameters

vendor_idstring uuid

Optional UUID filter by vendor.

limitinteger

Maximum number of rows to return in the page.

cursorstring

If defined, a cursor to retrieve the next page.

Example:iLQvkEj3sh3UiweC

Pagination cursor to navigate through the full response.

subsidiary_idstring uuid

Subsidiary to be used when filtering data

updated.gtstring date-time
Example:2023-01-01T00:00:00Z

Filter vendor credits updated after this timestamp

Response

OK

Example response

{
  "vendor_credits": [
    {
      "credit_number": "VC-001",
      "line_items": [
        {
          "account_code": "11112",
          "amount": {
            "amount": "1.01",
            "currency": "USD"
          },
          "tax_rate": {
            "percentage": "0",
            "tax_amount": {
              "amount": "1.01",
              "currency": "USD"
            },
            "country": "US"
          },
          "net_amount": {
            "amount": "1.01",
            "currency": "USD"
          },
          "tax_amount": {
            "amount": "1.01",
            "currency": "USD"
          }
        }
      ],
      "amount": {
        "amount": "1.01",
        "currency": "USD"
      },
      "applied_amount": {
        "amount": "1.01",
        "currency": "USD"
      },
      "remaining_amount": {
        "amount": "1.01",
        "currency": "USD"
      },
      "applications": [
        {
          "amount": {
            "amount": "1.01",
            "currency": "USD"
          }
        }
      ]
    }
  ],
  "pagination": {
    "next_cursor": "iLQvkEj3sh3UiweC"
  }
}

Changes

  • c393d0102005Revision changes
    • breaking

      the ///////////////////// response's property type changed from number to string, and format from no format to number for status

    • breaking

      the ////////////////// response's property type changed from number to string, and format from no format to number for status

    • info

      added the optional property //////////// to the response with the status

    • info

      added the optional property ///////// to the response with the status