Sign in

v1

latestOpenAPI 3.1.02026-07-24111224223.3 KB
Vendor Credits

Updates a vendor credit

IMPORTANT: This is a full-replace operation (PUT semantics). All fields must be included in the request body — omitting any field will set it to null, wiping existing data. Always call retrieve-a-vendor-credit first to fetch the current record, then include ALL existing fields in your update request along with your changes.

put/vendor-credits/{vendor_credit_id}

Path parameters

vendor_credit_idstring uuid required

UUID of the vendor credit to be used in this operation.

Request body

credit_numberstring required
datestring date required
gl_impact_datestring date required
memostring
vendor_idstring uuid required

Example request

{
  "credit_number": "VC-001",
  "line_items": [
    {
      "account_code": "11112",
      "amount": {
        "amount": "1.01",
        "currency": "USD"
      },
      "tax_rate": {
        "tax_amount": {
          "amount": "1.01",
          "currency": "USD"
        },
        "country": "US"
      }
    }
  ]
}

Response

OK

credit_numberstring required
datestring date required
gl_impact_datestring date required
memostring
vendor_idstring uuid required
subsidiary_idstring uuid required
idstring uuid required
organization_idstring uuid required
status'UNAPPLIED' | 'PARTIALLY_APPLIED' | 'REFUNDED' | 'APPLIED' required
updated_atstring date-time required

Timestamp when the vendor credit was last modified

Example response

{
  "credit_number": "VC-001",
  "line_items": [
    {
      "account_code": "11112",
      "amount": {
        "amount": "1.01",
        "currency": "USD"
      },
      "tax_rate": {
        "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"
      }
    }
  ]
}