API / Company
Use case / Master data sync

Get Company Validity

Changed on

Fetches a specific validity for a company.

get/v1/companies/company/{company_id}/validity/{id}

Request

  • Base URL: https://api.qargo.com
  • URL: https://api.qargo.com/v1/companies/company/{company_id}/validity/{id}
  • Auth: OAuth 2 (client credentials, token URL /v1/auth/token)

Path parameters

company_idstring uuid required
idstring uuid required

Response

Successful Response

start_timestring date-time required

Start time of the validity

end_timestring date-time nullable

End time of the validity from a planning perspective

legal_end_timestring date-time nullable

End time of the validity from a legal perspective

generate_unavailabilityboolean

Generate a planning unavailability once the validity end time has passed

type'ATA_CARNET' | 'BANK_DETAILS' | 'CMR_INSURANCE' | 'COMMON_HEALTH_ENTRY_DOCUMENT' | 'COMMUNICATION' | 'COMMUNICATION_SUBCONTRACTOR' | 'SUBCONTRACTOR_CONTRACT' | 'CREDIT_REPORT' | 'DGSA_CERTIFICATE' | 'ECMT_TRANSPORT_LICENSE' | 'EU_TRANSPORT_LICENSE' | 'EXPORT_HEALTH_CERTIFICATE' | 'FINE' | 'FREIGHT_FORWARDER_LICENSE' | 'SUBCONTRACTOR_LICENSE' | 'NATIONAL_TRANSPORT_LICENSE' | 'SUBCONTRACTOR_OTHER' | 'SUBCONTRACTOR_PERMIT' | 'POWER_OF_ATTORNEY' | 'QUESTIONNAIRE_CUSTOMER' | 'QUESTIONNAIRE_SUBCONTRACTOR' | 'SERVICE_LEVEL_AGREEMENT' | 'SQAS_CERTIFICATE' | 'COMPANY_TDS' | 'TRAILER_CLEANING_CERTIFICATE' | 'VAT_VIES_VALIDATION' | 'SUBCONTRACTOR_WASTE_LICENSE' | 'WASTE_PERMIT_GREEN_EU' | 'WASTE_PERMIT_ORANGE_EU' | 'WASTE_PERMIT_ORANGE_GREEN_EU' | 'XL_CERTIFICATE' | 'DOMESTIC_CARGO_INSURANCE' | 'SUBCONTRACTOR_INSURANCE' | 'INSURANCE_3RD_PARTY_TRAILER' | 'CARGO_INSURANCE' | 'SUBCONTRACTOR_LIABILITY_INSURANCE' | 'SUBCONTRACTOR_MOTOR_INSURANCE' required
external_idstring nullable

ID of the validity in the external master data system

descriptionstring nullable
idstring uuid required

Unique identifier of the validity

Changes

  • 6abdfcd1a541Revision changes
    • info

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

    • info

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