Updates an existing invoice adjustment

PATCH /api/billing/invoice-adjustment/{id}

TBD

Path parameters

  • id integer(int64) Required

    Invoice Adjustment ID

application/json

Body

  • period_code string

    Optional invoice periodCode. If missing: this adjustment is applied in all periods. If present: The adjustment is applied when the invoice periodCode is equal to this period code

  • description string

    Optional description

  • amount number Required

    Adjustment amount

Responses

  • 200 application/json

    OK

    Hide response attributes Show response attributes object
    • id integer(int64)

      TBC

    • yard_id integer(int64)

      Identifier for the yard

    • carrier_id integer(int64)

      Identifier for the carrier

    • period_code string

      Optional invoice periodCode. If missing: this adjustment is applied in all periods. If present: The adjustment is applied when the invoice periodCode is equal to this period code

    • description string

      Optional description

    • amount number Required

      Adjustment amount

    • created_at

      Timestamp when the adjustment was created

    • created_by string

      User who created the adjustment

    • last_modified_at

      Timestamp when the adjustment was last updated

    • last_modified_by string

      User who last updated the adjustment
  • 401

    Not Authorized

  • 403

    Not Allowed

PATCH /api/billing/invoice-adjustment/{id} 
curl \
 -X PATCH https://api-dev.gatego.io/api/billing/invoice-adjustment/{id} \
 -H "Content-Type: application/json" \
 -d '{"period_code":"202405","description":"Discount for early payment","amount":100.75}'
Request examples 
{
  "period_code": "202405",
  "description": "Discount for early payment",
  "amount": 100.75
}
Response examples (200) 
{
  "id": "TBC",
  "yard_id": 2,
  "carrier_id": 3,
  "period_code": "202405",
  "description": "Discount for early payment",
  "amount": 100.75,
  "created_at": "2021-09-30T18:25:07Z",
  "created_by": "admin",
  "last_modified_at": "2021-09-30T20:45:07Z",
  "last_modified_by": "admin"
}