Light APIv1.0.0

API / Reference / Purchase Orders

Close purchase order

POST https://api.light.inc/v1/purchase-orders/{purchaseOrderId}/close

Closes a purchase order

Authorization

Send one of these on every request. See Authentication for how to get credentials.

  • API key

    Basic authentication header of the form Basic <api_key>, where <api_key> is your api key.

  • Bearer token

Path parameters

  • purchaseOrderId string · uuidrequired

Response

  • id string · uuid

  • companyId string · uuid

  • createdBy string · uuid

  • companyEntityId string · uuid

  • purchaseRequestId string · uuid

  • state string

    ⚠️ This enum is not exhaustive; new values may be added in the future.

    One of IN_DRAFT RESET_PENDING APPROVED_ACCOUNTING_ENTRY_PENDING OPEN CLOSE_PENDING CLOSED CANCEL_PENDING CANCELLED

  • totalAmount integer · int64

  • totalNetAmount integer · int64

  • totalTaxAmount integer · int64

  • erpNumber string

  • description string

  • currency string

  • ownerId string · uuid

  • vendorId string · uuid

  • vendorEmail string

  • deliveryAddress string

  • deliveryDate string · date

  • documentKey string

  • failureContext object

    Failure context when vendor onboarding fails.

    • name string

      The error name

    • type string

      The error type

      ⚠️ This enum is not exhaustive; new values may be added in the future.

      One of BAD_REQUEST UNAUTHORIZED FORBIDDEN NOT_FOUND CONFLICT UNPROCESSABLE_CONTENT

    • errors array of object

      List of errors providing details about what went wrong

      • type string

        A string code identifying the error type

      • message string

        A human-readable message providing more details about the error

      • path array of string

        Optional path of the error when the error is for a specific field. Used mostly on BAD_REQUEST errors, that path will match the field name on the request object

      • context object

        Optional context providing additional information about the error. This can include any relevant data that might help in understanding or resolving the error

  • editStatus string

    ⚠️ This enum is not exhaustive; new values may be added in the future.

    One of ALL_EDITS_ALLOWED ALL_EDITS_LOCKED CORE_EDITS_LOCKED

  • purchaseOrderDate string · date

  • erpSyncedAt string · date-time

  • lockedAt string · date-time

  • closedAt string · date-time

  • cancelledAt string · date-time

  • createdAt string · date-time

  • updatedAt string · date-time

  • lines array of object

    • id string · uuid

    • companyId string · uuid

    • purchaseOrderId string · uuid

    • description string

    • costCenterId string · uuid

    • accountId string · uuid

    • taxCodeId string · uuid

    • quantity number

    • unitPrice integer · int64

    • amount integer · int64

    • netAmount integer · int64

    • createdAt string · date-time

    • updatedAt string · date-time

    • customProperties array of object

      • groupId string · uuid

        ID of the custom property group

      • groupInternalName string

        Internal name of the custom property group

      • values array of object

        List of values. Note that this will be a single value unless the group input type supports multiple values

        • id string · uuid

          Unique identifier for the object

        • groupId string · uuid

          ID of the custom property group

        • groupInternalName string

          Internal name of the custom property group

        • companyId string · uuid

          ID of the company

        • internalName string

          Internal name of the custom property value

        • label string

          Label of the custom property value

        • context string

          Context/description of the custom property value

        • createdAt string · date-time

          Timestamp when the custom property value was created

        • updatedAt string · date-time

          Timestamp when the custom property value was last updated

  • customProperties array of object

    • groupId string · uuid

      ID of the custom property group

    • groupInternalName string

      Internal name of the custom property group

    • values array of object

      List of values. Note that this will be a single value unless the group input type supports multiple values

      • id string · uuid

        Unique identifier for the object

      • groupId string · uuid

        ID of the custom property group

      • groupInternalName string

        Internal name of the custom property group

      • companyId string · uuid

        ID of the company

      • internalName string

        Internal name of the custom property value

      • label string

        Label of the custom property value

      • context string

        Context/description of the custom property value

      • createdAt string · date-time

        Timestamp when the custom property value was created

      • updatedAt string · date-time

        Timestamp when the custom property value was last updated