-
Notifications
You must be signed in to change notification settings - Fork 0
/
safracontrol-integration-api-json.json
1 lines (1 loc) · 105 KB
/
safracontrol-integration-api-json.json
1
{"openapi":"3.0.0","info":{"title":"SafraControl Integration","description":"SafraControl integration API","version":"1.0","contact":{},"license":{"name":"private","url":"souagrosolucoes.com.br"}},"tags":[],"servers":[{"url":"https://api.staging.gruposinagro.souagrosolucoes.com.br/integration"}],"components":{"securitySchemes":{"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http"}},"schemas":{"ForbiddenResponse":{"type":"object","properties":{"statusCode":{"type":"number","description":"Status code","example":403},"message":{"type":"string","description":"Message","example":"Forbidden resource"},"error":{"type":"string","description":"Error message","example":"Forbidden"}},"required":["statusCode","message","error"]},"InnerDTO":{"type":"object","properties":{"externalId":{"type":"string","description":"Integration identifier. This value can be the ID from another service (i.e., Salesforce, SAP or SIAGRI)","example":"aaaa-sdsdsd-262363636"}},"required":["externalId"]},"CreateOrderDto":{"type":"object","properties":{"externalId":{"type":"string","description":"Integration identifier. This value can be the ID from another service (i.e., Salesforce, SAP or SIAGRI)","example":"ab123cd"},"externalOrderId":{"type":"string","description":"Identificador do pedido","example":"cd123ab"},"type":{"type":"string","description":"Tipo do pedido","example":"normal","default":"normal","enum":["normal","purchase","transfer"]},"freightType":{"type":"string","description":"freight type","example":"cif"},"enabled":{"type":"boolean","description":"Enabled status. If this order is enabled set it to true, otherwise, set it to false","example":true},"period":{"description":"Period of order","allOf":[{"$ref":"#/components/schemas/InnerDTO"}]},"dueDate":{"type":"string","description":"Order due date","example":"2020-06-03"},"customer":{"description":"Customer of order","allOf":[{"$ref":"#/components/schemas/InnerDTO"}]},"branchOffice":{"description":"Branch office of order","allOf":[{"$ref":"#/components/schemas/InnerDTO"}]},"group":{"description":"Group of order","allOf":[{"$ref":"#/components/schemas/InnerDTO"}]},"seller":{"description":"Seller of order","allOf":[{"$ref":"#/components/schemas/InnerDTO"}]},"regional":{"description":"Regional of order","allOf":[{"$ref":"#/components/schemas/InnerDTO"}]},"withdrawalPlace":{"description":"Withdrawal place of order","allOf":[{"$ref":"#/components/schemas/InnerDTO"}]},"specialAttention":{"type":"boolean","description":"If exist special information for the item","example":true},"specialAttentionDescription":{"type":"string","description":"Description of the special information for the item.","example":"germinação 80%"}},"required":["externalId","freightType","period","dueDate","customer","branchOffice"]},"BadRequestResponse":{"type":"object","properties":{"statusCode":{"type":"number","description":"Status code","example":400},"message":{"description":"Message","example":["The type INVALID_TYPE is not valid. Expected: branchOffice, customer, ..."],"type":"array","items":{"type":"string"}},"error":{"type":"string","description":"Error message","example":"Bad request"}},"required":["statusCode","message","error"]},"NotFoundResponse":{"type":"object","properties":{"statusCode":{"type":"number","description":"Status code","example":404},"message":{"type":"string","description":"Message","example":"The entity ab123cd not found"}},"required":["statusCode","message"]},"UpdateOrderDto":{"type":"object","properties":{"externalOrderId":{"type":"string","description":"Identificador do pedido","example":"cd123ab"},"type":{"type":"string","description":"Tipo do pedido","example":"normal","default":"normal","enum":["normal","purchase","transfer"]},"freightType":{"type":"string","description":"freight type","example":"cif"},"enabled":{"type":"boolean","description":"Enabled status. If this order is enabled set it to true, otherwise, set it to false","example":true},"period":{"description":"Period of order","allOf":[{"$ref":"#/components/schemas/InnerDTO"}]},"dueDate":{"type":"string","description":"Order due date","example":"2020-06-03"},"customer":{"description":"Customer of order","allOf":[{"$ref":"#/components/schemas/InnerDTO"}]},"branchOffice":{"description":"Branch office of order","allOf":[{"$ref":"#/components/schemas/InnerDTO"}]},"group":{"description":"Group of order","allOf":[{"$ref":"#/components/schemas/InnerDTO"}]},"seller":{"description":"Seller of order","allOf":[{"$ref":"#/components/schemas/InnerDTO"}]},"regional":{"description":"Regional of order","allOf":[{"$ref":"#/components/schemas/InnerDTO"}]},"withdrawalPlace":{"description":"Withdrawal place of order","allOf":[{"$ref":"#/components/schemas/InnerDTO"}]},"specialAttention":{"type":"boolean","description":"If exist special information for the item","example":true},"specialAttentionDescription":{"type":"string","description":"Description of the special information for the item.","example":"germinação 80%"}},"required":["freightType","period","dueDate","customer","branchOffice"]},"GetCargoOrderDto":{"type":"object","properties":{"cargos":{"description":"Lista de identificadores das cargas","example":[81615,6465,65856],"type":"array","items":{"type":"string"}}},"required":["cargos"]},"CreateGroupDto":{"type":"object","properties":{"externalId":{"type":"string","description":"Integration identifier. This value can be the ID from another service (i.e., Salesforce, SAP or SIAGRI)","example":"soja"},"name":{"type":"string","description":"Product group name","example":"Soja"},"enabled":{"type":"boolean","description":"Enable or disable the group","example":true,"default":true}},"required":["externalId","name"]},"CreateProductVarietyDto":{"type":"object","properties":{"externalId":{"type":"string","description":"Integration identifier. This value can be the ID from another service (i.e., Salesforce, SAP or SIAGRI)","example":"nrc-12"},"name":{"type":"string","description":"Product variety name","example":"NRC-12"}},"required":["externalId","name"]},"SupplierExternalIdDto":{"type":"object","properties":{"externalId":{"type":"string","description":"Integration identifier. This value can be the ID from another service (i.e., Salesforce, SAP or SIAGRI)","example":"ab123cd"}},"required":["externalId"]},"ProductDto":{"type":"object","properties":{"externalId":{"type":"string","description":"Este valor pode ser o ID de integração de outro serviço (i.e., Salesforce, SAP or SIAGRI)","example":"ab123cd"},"name":{"type":"string","description":"Nome do produto","example":"SEM SOJA NS 8383 IPRO TA P5,5 (BAG 1000KG)"},"weight":{"type":"number","description":"Peso do produto","example":1000},"unit":{"type":"string","description":"Embalagem do produto (i.e., BAG 1.000kg, Caixa 100ml, Galão 5LT, SC 40kg)","example":"semente"},"conversionFactor":{"type":"number","description":"Fator de conversão da quantidade do produto para ser convertido para a unidade de medida \"grama\". Desta forma, se a quantidade for em kilograma esse campo deveria ter o valor de 1000.","example":1000},"multiple":{"type":"number","description":"Quantidade base do produto","example":100},"ncm":{"type":"string","description":"NCM do produto","example":"00000000"},"group":{"description":"Grupo do produto, este valor pode ser o ID de integração de outro serviço (i.e., Salesforce, SAP or SIAGRI)","allOf":[{"$ref":"#/components/schemas/CreateGroupDto"}]},"variety":{"description":"Variedade do produto","allOf":[{"$ref":"#/components/schemas/CreateProductVarietyDto"}]},"supplier":{"description":"Fornecedor do produto, este valor pode ser o ID de integração de outro serviço (i.e., Salesforce, SAP or SIAGRI)","allOf":[{"$ref":"#/components/schemas/SupplierExternalIdDto"}]}},"required":["externalId"]},"CreateOrderItemDto":{"type":"object","properties":{"externalId":{"type":"string","description":"Integration identifier. This value can be the ID from another service (i.e., Salesforce, SAP or SIAGRI)","example":"ab123cd"},"externalOrderItemId":{"type":"string","description":"Identificador do item do pedido","example":"cd123ab"},"itemCode":{"type":"string","description":"Identificador do item da remessa.","example":"000010"},"quantity":{"type":"number","description":"Quantidade unitária do produto.","example":10},"enabled":{"type":"boolean","description":"Enabled status. If this item is enabled set it to true, otherwise, set it to false","example":true,"default":true},"canceled":{"type":"boolean","description":"Canceled status. If this item is canceled set it to true, otherwise, set it to false","example":false,"default":false},"status":{"type":"string","description":"Status","example":"released"},"unitValue":{"type":"number","description":"Unit value","example":10.5},"totalValue":{"type":"number","description":"Total value","example":105},"tradingFee":{"type":"number","description":"Trading fee value","example":8.5},"unitValueReal":{"type":"number","description":"Unit value in real","example":105},"currency":{"type":"string","description":"Currency name","example":"real"},"purchaseOrderCode":{"type":"string","description":"Código do pedido de compra","example":"psh12343"},"supplierOrderCode":{"type":"string","description":"Código do pedido do fornecedor","example":"fsh12343"},"schedulingDate":{"type":"string","description":"Data esperada para que todo o pedido seja entegue","example":"2021-09-01"},"order":{"description":"Order","allOf":[{"$ref":"#/components/schemas/InnerDTO"}]},"product":{"description":"Product","allOf":[{"$ref":"#/components/schemas/ProductDto"}]},"withdrawalPlace":{"description":"Withdrawal place of order","allOf":[{"$ref":"#/components/schemas/InnerDTO"}]},"shippingAddress":{"description":"Shipping address registed in an contact. Normally is the externalId of a contact entity.","allOf":[{"$ref":"#/components/schemas/InnerDTO"}]},"cultivation":{"description":"Cultivation","allOf":[{"$ref":"#/components/schemas/InnerDTO"}]},"group":{"description":"Item group","allOf":[{"$ref":"#/components/schemas/InnerDTO"}]},"seller":{"description":"Seller of order","allOf":[{"$ref":"#/components/schemas/InnerDTO"}]},"specialAttention":{"type":"boolean","description":"If exist special information for the item","example":true},"specialAttentionDescription":{"type":"string","description":"Description of the special information for the item.","example":"item refrigerado, modelo AXB11"}},"required":["externalId","itemCode","quantity","order","product","withdrawalPlace","shippingAddress","cultivation"]},"UpdateOrderItemDto":{"type":"object","properties":{"externalOrderItemId":{"type":"string","description":"Identificador do item do pedido","example":"cd123ab"},"itemCode":{"type":"string","description":"Identificador do item da remessa.","example":"000010"},"quantity":{"type":"number","description":"Quantidade unitária do produto.","example":10},"enabled":{"type":"boolean","description":"Enabled status. If this item is enabled set it to true, otherwise, set it to false","example":true,"default":true},"canceled":{"type":"boolean","description":"Canceled status. If this item is canceled set it to true, otherwise, set it to false","example":false,"default":false},"status":{"type":"string","description":"Status","example":"released"},"unitValue":{"type":"number","description":"Unit value","example":10.5},"totalValue":{"type":"number","description":"Total value","example":105},"tradingFee":{"type":"number","description":"Trading fee value","example":8.5},"unitValueReal":{"type":"number","description":"Unit value in real","example":105},"currency":{"type":"string","description":"Currency name","example":"real"},"purchaseOrderCode":{"type":"string","description":"Código do pedido de compra","example":"psh12343"},"supplierOrderCode":{"type":"string","description":"Código do pedido do fornecedor","example":"fsh12343"},"schedulingDate":{"type":"string","description":"Data esperada para que todo o pedido seja entegue","example":"2021-09-01"},"order":{"description":"Order","allOf":[{"$ref":"#/components/schemas/InnerDTO"}]},"product":{"description":"Product","allOf":[{"$ref":"#/components/schemas/ProductDto"}]},"withdrawalPlace":{"description":"Withdrawal place of order","allOf":[{"$ref":"#/components/schemas/InnerDTO"}]},"shippingAddress":{"description":"Shipping address registed in an contact. Normally is the externalId of a contact entity.","allOf":[{"$ref":"#/components/schemas/InnerDTO"}]},"cultivation":{"description":"Cultivation","allOf":[{"$ref":"#/components/schemas/InnerDTO"}]},"group":{"description":"Item group","allOf":[{"$ref":"#/components/schemas/InnerDTO"}]},"seller":{"description":"Seller of order","allOf":[{"$ref":"#/components/schemas/InnerDTO"}]},"specialAttention":{"type":"boolean","description":"If exist special information for the item","example":true},"specialAttentionDescription":{"type":"string","description":"Description of the special information for the item.","example":"item refrigerado, modelo AXB11"}},"required":["itemCode","quantity","order","product","withdrawalPlace","shippingAddress","cultivation"]},"ContactDto":{"type":"object","properties":{"name":{"type":"string","description":"Name","example":"4TB PRODUTOS AGRICOLAS S.A."},"aliasName":{"type":"string","description":"Alias name","example":"4TB PRODUTOS AGRICOLAS"},"person":{"type":"string","description":"Person type (e.g., natural or juridical)","example":"juridical","enum":["juridical","natural"]},"description":{"type":"string","description":"Description","example":"Contact to send my products"},"enabled":{"type":"boolean","description":"Enabled status","example":true,"default":true},"identificationNumber":{"type":"string","description":"Identification number (e.g., in Brazil: CPF or CNPJ)","example":"79676514000111"},"secondIdentificationNumber":{"type":"string","description":"Second identification number (e.g., in Brazil: State registration)","example":"392982270772"}},"required":["name","identificationNumber"]},"ContactAddressDto":{"type":"object","properties":{"name":{"type":"string","description":"Name","example":"Name to identify the address"},"description":{"type":"string","description":"Description","example":"Address to receive orders"},"postalCode":{"type":"string","description":"Postal code","example":"74080000"},"street":{"type":"string","description":"Street name","example":"Rua P08"},"district":{"type":"string","description":"District name","example":"Central"},"complement":{"type":"string","description":"Address complement","example":"Qd. 10 Bloco 33"},"city":{"type":"string","description":"City name","example":"Goiânia"},"cityId":{"type":"number","description":"City id","example":"5208707"},"state":{"type":"string","description":"State name","example":"Goiás"},"country":{"type":"string","description":"Country name","example":"Brazil"},"latitude":{"type":"number","description":"Latitude","example":-16.677359},"longitude":{"type":"number","description":"Longitude","example":-49.257193},"primaryContactName":{"type":"string","description":"Primary contact name","example":"Mark Zuckerberg"},"addressRoute":{"type":"string","description":"External id to route indetification","example":"BR153-GO020"}}},"CreateContactDto":{"type":"object","properties":{"externalId":{"type":"string","description":"Integration identifier. This value can be the ID from another service (i.e., Salesforce, SAP or SIAGRI)","example":"ab123cd"},"contact":{"description":"Contact informations","allOf":[{"$ref":"#/components/schemas/ContactDto"}]},"address":{"description":"Address","allOf":[{"$ref":"#/components/schemas/ContactAddressDto"}]},"type":{"type":"string","description":"Contact type","example":"branchOffice","enum":["branchOffice","customer","driver","seller","supplier","transportCompany","withdrawalPlace","deposit"]}},"required":["externalId","contact","type"]},"ContactResponse":{"type":"object","properties":{"externalId":{"type":"string","description":"Integration identifier. This value can be the ID from another service (i.e., Salesforce, SAP or SIAGRI)","example":"ab123cd"},"contact":{"description":"Contact informations","allOf":[{"$ref":"#/components/schemas/ContactDto"}]},"address":{"description":"Address","allOf":[{"$ref":"#/components/schemas/ContactAddressDto"}]}},"required":["externalId","contact"]},"UpdateContactDto":{"type":"object","properties":{"contact":{"description":"Contact informations","allOf":[{"$ref":"#/components/schemas/ContactDto"}]},"address":{"description":"Address","allOf":[{"$ref":"#/components/schemas/ContactAddressDto"}]},"type":{"type":"string","description":"Contact type","example":"branchOffice","enum":["branchOffice","customer","driver","seller","supplier","transportCompany","withdrawalPlace","deposit"]}},"required":["contact","type"]},"CreateBranchOfficeDto":{"type":"object","properties":{"externalId":{"type":"string","description":"Integration identifier. This value can be the ID from another service (i.e., Salesforce, SAP or SIAGRI)","example":"ab123cd"},"contact":{"description":"Contact informations","allOf":[{"$ref":"#/components/schemas/ContactDto"}]},"address":{"description":"Address","allOf":[{"$ref":"#/components/schemas/ContactAddressDto"}]}},"required":["externalId","contact"]},"UpdateBranchOfficeDto":{"type":"object","properties":{"contact":{"description":"Contact informations","allOf":[{"$ref":"#/components/schemas/ContactDto"}]},"address":{"description":"Address","allOf":[{"$ref":"#/components/schemas/ContactAddressDto"}]}},"required":["contact"]},"CreateCustomerDto":{"type":"object","properties":{"externalId":{"type":"string","description":"Integration identifier. This value can be the ID from another service (i.e., Salesforce, SAP or SIAGRI)","example":"ab123cd"},"contact":{"description":"Contact informations","allOf":[{"$ref":"#/components/schemas/ContactDto"}]},"address":{"description":"Address","allOf":[{"$ref":"#/components/schemas/ContactAddressDto"}]},"salesTeam":{"description":"Grupo do produto, este valor pode ser o ID de integração de outro serviço (i.e., Salesforce, SAP or SIAGRI)","allOf":[{"$ref":"#/components/schemas/InnerDTO"}]}},"required":["externalId","contact"]},"UpdateCustomerDto":{"type":"object","properties":{"contact":{"description":"Contact informations","allOf":[{"$ref":"#/components/schemas/ContactDto"}]},"address":{"description":"Address","allOf":[{"$ref":"#/components/schemas/ContactAddressDto"}]},"salesTeam":{"description":"Grupo do produto, este valor pode ser o ID de integração de outro serviço (i.e., Salesforce, SAP or SIAGRI)","allOf":[{"$ref":"#/components/schemas/InnerDTO"}]}},"required":["contact"]},"CreateDriverDto":{"type":"object","properties":{"externalId":{"type":"string","description":"Integration identifier. This value can be the ID from another service (i.e., Salesforce, SAP or SIAGRI)","example":"ab123cd"},"contact":{"description":"Contact informations","allOf":[{"$ref":"#/components/schemas/ContactDto"}]},"address":{"description":"Address","allOf":[{"$ref":"#/components/schemas/ContactAddressDto"}]}},"required":["externalId","contact"]},"UpdateDriverDto":{"type":"object","properties":{"contact":{"description":"Contact informations","allOf":[{"$ref":"#/components/schemas/ContactDto"}]},"address":{"description":"Address","allOf":[{"$ref":"#/components/schemas/ContactAddressDto"}]}},"required":["contact"]},"UpdateGroupDto":{"type":"object","properties":{"name":{"type":"string","description":"Product group name","example":"Soja"},"enabled":{"type":"boolean","description":"Enable or disable the group","example":true,"default":true}},"required":["name"]},"CreatePeriodDto":{"type":"object","properties":{"externalId":{"type":"string","description":"Integration identifier. This value can be the ID from another service (i.e., Salesforce, SAP or SIAGRI)","example":"0b261b3f-79e1-433c-98ec-288f0f53b91a"},"name":{"type":"string","description":"Period name","example":"SAFRA 20/20"},"enabled":{"type":"boolean","description":"Enable or disable the period","example":true,"default":true},"fromDate":{"type":"string","description":"from date, initial period data","example":"2020-01-01","default":true},"thruDate":{"type":"string","description":"thru date, the limit date of period","example":"2020-09-03","default":true},"description":{"type":"string","description":"Period description","example":"Novo perído para a SAFRA 2020","default":true}},"required":["externalId","name","enabled","fromDate","thruDate","description"]},"UpdatePeriodDto":{"type":"object","properties":{"name":{"type":"string","description":"Period name","example":"SAFRA 20/20"},"enabled":{"type":"boolean","description":"Enable or disable the period","example":true,"default":true},"fromDate":{"type":"string","description":"from date, initial period data","example":"2020-01-01","default":true},"thruDate":{"type":"string","description":"thru date, the limit date of period","example":"2020-09-03","default":true},"description":{"type":"string","description":"Period description","example":"Novo perído para a SAFRA 2020","default":true}},"required":["name","enabled","fromDate","thruDate","description"]},"UpdateProductDto":{"type":"object","properties":{"name":{"type":"string","description":"Nome do produto","example":"SEM SOJA NS 8383 IPRO TA P5,5 (BAG 1000KG)"},"weight":{"type":"number","description":"Peso do produto","example":1000},"unit":{"type":"string","description":"Embalagem do produto (i.e., BAG 1.000kg, Caixa 100ml, Galão 5LT, SC 40kg)","example":"semente"},"conversionFactor":{"type":"number","description":"Fator de conversão da quantidade do produto para ser convertido para a unidade de medida \"grama\". Desta forma, se a quantidade for em kilograma esse campo deveria ter o valor de 1000.","example":1000},"multiple":{"type":"number","description":"Quantidade base do produto","example":100},"ncm":{"type":"string","description":"NCM do produto","example":"00000000"},"group":{"description":"Grupo do produto, este valor pode ser o ID de integração de outro serviço (i.e., Salesforce, SAP or SIAGRI)","allOf":[{"$ref":"#/components/schemas/CreateGroupDto"}]},"variety":{"description":"Variedade do produto","allOf":[{"$ref":"#/components/schemas/CreateProductVarietyDto"}]},"supplier":{"description":"Fornecedor do produto, este valor pode ser o ID de integração de outro serviço (i.e., Salesforce, SAP or SIAGRI)","allOf":[{"$ref":"#/components/schemas/SupplierExternalIdDto"}]}}},"UpdateProductVarietyDto":{"type":"object","properties":{"name":{"type":"string","description":"Product variety name","example":"NRC-12"}},"required":["name"]},"CreateRegionalDto":{"type":"object","properties":{"externalId":{"type":"string","description":"Integration identifier. This value can be the ID from another service (i.e., Salesforce, SAP or SIAGRI)","example":"0b261b3f-79e1-433c-98ec-288f0f53b91a"},"name":{"type":"string","description":"Period name","example":"Regional 01"},"enabled":{"type":"boolean","description":"Enable or disable the regional","example":true,"default":true}},"required":["externalId","name","enabled"]},"UpdateRegionalDto":{"type":"object","properties":{"name":{"type":"string","description":"Period name","example":"Regional 01"},"enabled":{"type":"boolean","description":"Enable or disable the regional","example":true,"default":true}},"required":["name","enabled"]},"CreateSellerDto":{"type":"object","properties":{"externalId":{"type":"string","description":"Integration identifier. This value can be the ID from another service (i.e., Salesforce, SAP or SIAGRI)","example":"ab123cd"},"contact":{"description":"Contact informations","allOf":[{"$ref":"#/components/schemas/ContactDto"}]},"address":{"description":"Address","allOf":[{"$ref":"#/components/schemas/ContactAddressDto"}]}},"required":["externalId","contact"]},"UpdateSellerDto":{"type":"object","properties":{"contact":{"description":"Contact informations","allOf":[{"$ref":"#/components/schemas/ContactDto"}]},"address":{"description":"Address","allOf":[{"$ref":"#/components/schemas/ContactAddressDto"}]}},"required":["contact"]},"CreateSupplierDto":{"type":"object","properties":{"externalId":{"type":"string","description":"Integration identifier. This value can be the ID from another service (i.e., Salesforce, SAP or SIAGRI)","example":"ab123cd"},"contact":{"description":"Contact informations","allOf":[{"$ref":"#/components/schemas/ContactDto"}]},"address":{"description":"Address","allOf":[{"$ref":"#/components/schemas/ContactAddressDto"}]}},"required":["externalId","contact"]},"UpdateSupplierDto":{"type":"object","properties":{"contact":{"description":"Contact informations","allOf":[{"$ref":"#/components/schemas/ContactDto"}]},"address":{"description":"Address","allOf":[{"$ref":"#/components/schemas/ContactAddressDto"}]}},"required":["contact"]},"CreateTransportCompanyDto":{"type":"object","properties":{"externalId":{"type":"string","description":"Integration identifier. This value can be the ID from another service (i.e., Salesforce, SAP or SIAGRI)","example":"ab123cd"},"contact":{"description":"Contact informations","allOf":[{"$ref":"#/components/schemas/ContactDto"}]},"address":{"description":"Address","allOf":[{"$ref":"#/components/schemas/ContactAddressDto"}]}},"required":["externalId","contact"]},"UpdateTransportCompanyDto":{"type":"object","properties":{"contact":{"description":"Contact informations","allOf":[{"$ref":"#/components/schemas/ContactDto"}]},"address":{"description":"Address","allOf":[{"$ref":"#/components/schemas/ContactAddressDto"}]}},"required":["contact"]},"CreateTruckTypeDto":{"type":"object","properties":{"externalId":{"type":"string","description":"Integration identifier. This value can be the ID from another service (i.e., Salesforce, SAP or SIAGRI)","example":"rodo-trem"},"name":{"type":"string","description":"Truck type name","example":"Rodo-Trem"},"enabled":{"type":"boolean","description":"Enable or disable the truck type","example":true,"default":true},"capacity":{"type":"number","description":"Truck capacity in kilograms","example":50000,"default":true}},"required":["externalId","name","enabled","capacity"]},"UpdateTruckTypeDto":{"type":"object","properties":{"name":{"type":"string","description":"Truck type name","example":"Rodo-Trem"},"enabled":{"type":"boolean","description":"Enable or disable the truck type","example":true,"default":true},"capacity":{"type":"number","description":"Truck capacity in kilograms","example":50000,"default":true}},"required":["name","enabled","capacity"]},"CreateVehicleDto":{"type":"object","properties":{"externalId":{"type":"string","description":"Integration identifier. This value can be the ID from another service (i.e., Salesforce, SAP or SIAGRI)","example":"ab123cd"},"licensePlate":{"type":"string","description":"Vehicle license plate","example":"AB123CD"},"brand":{"type":"string","description":"Brand name","example":"volvo"},"model":{"type":"string","description":"Model name","example":"Volvo FH 540"},"color":{"type":"string","description":"Color name","example":"azul"},"type":{"type":"string","description":"Vehicle type","example":"truck"},"state":{"type":"string","description":"Vehicle license plate state","example":"GO"}},"required":["externalId","licensePlate"]},"UpdateVehicleDto":{"type":"object","properties":{"licensePlate":{"type":"string","description":"Vehicle license plate","example":"AB123CD"},"brand":{"type":"string","description":"Brand name","example":"volvo"},"model":{"type":"string","description":"Model name","example":"Volvo FH 540"},"color":{"type":"string","description":"Color name","example":"azul"},"type":{"type":"string","description":"Vehicle type","example":"truck"},"state":{"type":"string","description":"Vehicle license plate state","example":"GO"}},"required":["licensePlate"]},"CreateWithdrawalPlaceDto":{"type":"object","properties":{"externalId":{"type":"string","description":"Integration identifier. This value can be the ID from another service (i.e., Salesforce, SAP or SIAGRI)","example":"ab123cd"},"contact":{"description":"Contact informations","allOf":[{"$ref":"#/components/schemas/ContactDto"}]},"address":{"description":"Address","allOf":[{"$ref":"#/components/schemas/ContactAddressDto"}]},"capacity":{"type":"number","description":"capacity","example":1000},"weekendCapacity":{"type":"number","description":"weekendCapacity","example":3400000}},"required":["externalId","contact"]},"UpdateWithdrawalPlaceDto":{"type":"object","properties":{"contact":{"description":"Contact informations","allOf":[{"$ref":"#/components/schemas/ContactDto"}]},"address":{"description":"Address","allOf":[{"$ref":"#/components/schemas/ContactAddressDto"}]},"capacity":{"type":"number","description":"capacity","example":1000},"weekendCapacity":{"type":"number","description":"weekendCapacity","example":3400000}},"required":["contact"]},"DepositDto":{"type":"object","properties":{"externalId":{"type":"string","description":"Integration identifier. This value can be the ID from another service (i.e., Salesforce, SAP or SIAGRI)","example":"ab123cd"},"contact":{"description":"Contact informations","allOf":[{"$ref":"#/components/schemas/ContactDto"}]},"address":{"description":"Address","allOf":[{"$ref":"#/components/schemas/ContactAddressDto"}]},"branchOffice":{"description":"Filial que administra o depósito.","allOf":[{"$ref":"#/components/schemas/InnerDTO"}]}},"required":["externalId","contact","branchOffice"]},"UpdateDepositDto":{"type":"object","properties":{"contact":{"description":"Contact informations","allOf":[{"$ref":"#/components/schemas/ContactDto"}]},"address":{"description":"Address","allOf":[{"$ref":"#/components/schemas/ContactAddressDto"}]},"branchOffice":{"description":"Filial que administra o depósito.","allOf":[{"$ref":"#/components/schemas/InnerDTO"}]}},"required":["contact","branchOffice"]},"CreateSalesTeamDto":{"type":"object","properties":{"externalId":{"type":"string","description":"Integration identifier. This value can be the ID from another service (i.e., Salesforce, SAP or SIAGRI)","example":"0b261b3f-79e1-433c-98ec-288f0f53b91a"},"description":{"type":"string","description":"Sales team description","example":"Regional 01"},"name":{"type":"string","description":"Sales team name","example":"Araguapaz-GO"}},"required":["externalId","name"]},"UpdateSalesTeamDto":{"type":"object","properties":{"description":{"type":"string","description":"Sales team description","example":"Regional 01"},"name":{"type":"string","description":"Sales team name","example":"Araguapaz-GO"}},"required":["name"]},"InvoiceItem":{"type":"object","properties":{"externalId":{"type":"string","description":"Invoice external id","example":"100"},"xml":{"type":"string","description":"Fical document content (NFe XML)","example":"YXNkZmFzZGY="}},"required":["externalId"]},"InvoiceAttachFileDto":{"type":"object","properties":{"cargoId":{"type":"string","description":"CargoId","example":"13221"},"itemsExternalId":{"description":"ExternalIds sales order items ","example":"0080000115000010","type":"array","items":{"type":"array"}},"invoices":{"description":"Invoice list","type":"array","items":{"$ref":"#/components/schemas/InvoiceItem"}}},"required":["cargoId","itemsExternalId","invoices"]},"InvoiceAttachFileOutDto":{"type":"object","properties":{"success":{"type":"boolean","description":"status upload","example":true},"msg":{"type":"string","example":"upload failed or success"}},"required":["success","msg"]},"InvoiceAttachFileDeleteDto":{"type":"object","properties":{"externalId":{"type":"string","description":"external file id","example":"10010"}},"required":["externalId"]}}},"paths":{"/orders":{"post":{"operationId":"OrderController_create","summary":"[POST] orders","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOrderDto"}}}},"responses":{"201":{"description":"Get orders","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOrderDto"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}}},"tags":["orders"],"security":[{"bearer":[]}]}},"/orders/{externalId}":{"get":{"operationId":"OrderController_findOne","summary":"[GET] orders","parameters":[{"name":"externalId","required":true,"in":"path","description":"Integration identifier. This value can be the ID from another service (i.e., Salesforce, SAP or SIAGRI)","example":"ab123cd","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOrderDto"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}}},"tags":["orders"],"security":[{"bearer":[]}]},"put":{"operationId":"OrderController_update","summary":"[PUT] orders","parameters":[{"name":"externalId","required":true,"in":"path","description":"Integration identifier. This value can be the ID from another service (i.e., Salesforce, SAP or SIAGRI)","example":"ab123cd","schema":{"type":"string"}},{"name":"upsert","required":false,"in":"query","description":"Se `true` a entidade deve ser criada se não existir, caso contrário, será realizado apenas a atualização da entidade.","example":false,"schema":{"default":false,"type":"boolean"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateOrderDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOrderDto"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}}},"tags":["orders"],"security":[{"bearer":[]}]},"delete":{"operationId":"OrderController_remove","summary":"[DELETE] orders","parameters":[{"name":"externalId","required":true,"in":"path","description":"Integration identifier. This value can be the ID from another service (i.e., Salesforce, SAP or SIAGRI)","example":"ab123cd","schema":{"type":"string"}},{"name":"force","required":false,"in":"query","description":"Se `true` a entidade será excluída permanente do banco de dados, no entanto, se houve alguma outra entidade utilizando o registro ele não será removido, caso contrário, será realizado apenas a atualização da entidade para ser desativada.","example":false,"schema":{"default":false,"type":"boolean"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOrderDto"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}}},"tags":["orders"],"security":[{"bearer":[]}]}},"/orders/{externalId}/cargos":{"get":{"operationId":"OrderController_getCargos","summary":"[GET-CARGOS] orders","parameters":[{"name":"externalId","required":true,"in":"path","description":"Integration identifier. This value can be the ID from another service (i.e., Salesforce, SAP or SIAGRI)","example":"ab123cd","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCargoOrderDto"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}}},"tags":["orders"],"security":[{"bearer":[]}]}},"/order-items":{"post":{"operationId":"OrderItemController_create","summary":"[POST] order-items","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOrderItemDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOrderItemDto"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}}},"tags":["order-items"],"security":[{"bearer":[]}]}},"/order-items/{externalId}":{"get":{"operationId":"OrderItemController_findOne","summary":"[GET] order-items","parameters":[{"name":"externalId","required":true,"in":"path","description":"Integration identifier. This value can be the ID from another service (i.e., Salesforce, SAP or SIAGRI)","example":"ab123cd","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOrderItemDto"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}}},"tags":["order-items"],"security":[{"bearer":[]}]},"put":{"operationId":"OrderItemController_update","summary":"[PUT] order-items","parameters":[{"name":"externalId","required":true,"in":"path","description":"Integration identifier. This value can be the ID from another service (i.e., Salesforce, SAP or SIAGRI)","example":"ab123cd","schema":{"type":"string"}},{"name":"upsert","required":false,"in":"query","description":"Se `true` a entidade deve ser criada se não existir, caso contrário, será realizado apenas a atualização da entidade.","example":false,"schema":{"default":false,"type":"boolean"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateOrderItemDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOrderItemDto"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}}},"tags":["order-items"],"security":[{"bearer":[]}]},"delete":{"operationId":"OrderItemController_remove","summary":"[DELETE] order-items","parameters":[{"name":"externalId","required":true,"in":"path","description":"Integration identifier. This value can be the ID from another service (i.e., Salesforce, SAP or SIAGRI)","example":"ab123cd","schema":{"type":"string"}},{"name":"force","required":false,"in":"query","description":"Se `true` a entidade será excluída permanente do banco de dados, no entanto, se houve alguma outra entidade utilizando o registro ele não será removido, caso contrário, será realizado apenas a atualização da entidade para ser desativada.","example":false,"schema":{"default":false,"type":"boolean"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOrderItemDto"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}}},"tags":["order-items"],"security":[{"bearer":[]}]}},"/contacts":{"post":{"operationId":"ContactController_create","summary":"[POST] contacts","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateContactDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactResponse"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}}},"tags":["contacts"],"security":[{"bearer":[]}]}},"/contacts/{externalId}":{"get":{"operationId":"ContactController_findOne","summary":"[GET] contacts","parameters":[{"name":"externalId","required":true,"in":"path","description":"Integration identifier. This value can be the ID from another service (i.e., Salesforce, SAP or SIAGRI)","example":"ab123cd","schema":{"type":"string"}},{"name":"type","required":true,"in":"query","description":"Tipo do contato","example":"branchOffice","schema":{"enum":["branchOffice","customer","driver","seller","supplier","transportCompany","withdrawalPlace","deposit"],"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactResponse"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}}},"tags":["contacts"],"security":[{"bearer":[]}]},"put":{"operationId":"ContactController_update","summary":"[PUT] contacts","parameters":[{"name":"externalId","required":true,"in":"path","description":"Integration identifier. This value can be the ID from another service (i.e., Salesforce, SAP or SIAGRI)","example":"ab123cd","schema":{"type":"string"}},{"name":"upsert","required":false,"in":"query","description":"Se `true` a entidade deve ser criada se não existir, caso contrário, será realizado apenas a atualização da entidade.","example":false,"schema":{"default":false,"type":"boolean"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateContactDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactResponse"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}}},"tags":["contacts"],"security":[{"bearer":[]}]},"delete":{"operationId":"ContactController_remove","summary":"[DELETE] contacts","parameters":[{"name":"externalId","required":true,"in":"path","description":"Integration identifier. This value can be the ID from another service (i.e., Salesforce, SAP or SIAGRI)","example":"ab123cd","schema":{"type":"string"}},{"name":"force","required":false,"in":"query","description":"Se `true` a entidade será excluída permanente do banco de dados, no entanto, se houve alguma outra entidade utilizando o registro ele não será removido, caso contrário, será realizado apenas a atualização da entidade para ser desativada.","example":false,"schema":{"default":false,"type":"boolean"}},{"name":"type","required":true,"in":"query","description":"Tipo do contato","example":"branchOffice","schema":{"enum":["branchOffice","customer","driver","seller","supplier","transportCompany","withdrawalPlace","deposit"],"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactResponse"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}}},"tags":["contacts"],"security":[{"bearer":[]}]}},"/branch-offices":{"post":{"operationId":"BranchOfficeController_create","summary":"[POST] branch-offices","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBranchOfficeDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactResponse"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}}},"tags":["branch-offices"],"security":[{"bearer":[]}]}},"/branch-offices/{externalId}":{"get":{"operationId":"BranchOfficeController_findOne","summary":"[GET] branch-offices","parameters":[{"name":"externalId","required":true,"in":"path","description":"Integration identifier. This value can be the ID from another service (i.e., Salesforce, SAP or SIAGRI)","example":"ab123cd","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactResponse"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}}},"tags":["branch-offices"],"security":[{"bearer":[]}]},"put":{"operationId":"BranchOfficeController_update","summary":"[PUT] branch-offices","parameters":[{"name":"externalId","required":true,"in":"path","description":"Integration identifier. This value can be the ID from another service (i.e., Salesforce, SAP or SIAGRI)","example":"ab123cd","schema":{"type":"string"}},{"name":"upsert","required":false,"in":"query","description":"Se `true` a entidade deve ser criada se não existir, caso contrário, será realizado apenas a atualização da entidade.","example":false,"schema":{"default":false,"type":"boolean"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBranchOfficeDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactResponse"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}}},"tags":["branch-offices"],"security":[{"bearer":[]}]},"delete":{"operationId":"BranchOfficeController_remove","summary":"[DELETE] branch-offices","parameters":[{"name":"externalId","required":true,"in":"path","description":"Integration identifier. This value can be the ID from another service (i.e., Salesforce, SAP or SIAGRI)","example":"ab123cd","schema":{"type":"string"}},{"name":"force","required":false,"in":"query","description":"Se `true` a entidade será excluída permanente do banco de dados, no entanto, se houve alguma outra entidade utilizando o registro ele não será removido, caso contrário, será realizado apenas a atualização da entidade para ser desativada.","example":false,"schema":{"default":false,"type":"boolean"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactResponse"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}}},"tags":["branch-offices"],"security":[{"bearer":[]}]}},"/customers":{"post":{"operationId":"CustomerController_create","summary":"[POST] customers","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCustomerDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactResponse"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}}},"tags":["customers"],"security":[{"bearer":[]}]}},"/customers/{externalId}":{"get":{"operationId":"CustomerController_findOne","summary":"[GET] customers","parameters":[{"name":"externalId","required":true,"in":"path","description":"Integration identifier. This value can be the ID from another service (i.e., Salesforce, SAP or SIAGRI)","example":"ab123cd","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactResponse"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}}},"tags":["customers"],"security":[{"bearer":[]}]},"put":{"operationId":"CustomerController_update","summary":"[PUT] customers","parameters":[{"name":"externalId","required":true,"in":"path","description":"Integration identifier. This value can be the ID from another service (i.e., Salesforce, SAP or SIAGRI)","example":"ab123cd","schema":{"type":"string"}},{"name":"upsert","required":false,"in":"query","description":"Se `true` a entidade deve ser criada se não existir, caso contrário, será realizado apenas a atualização da entidade.","example":false,"schema":{"default":false,"type":"boolean"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCustomerDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactResponse"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}}},"tags":["customers"],"security":[{"bearer":[]}]},"delete":{"operationId":"CustomerController_remove","summary":"[DELETE] customers","parameters":[{"name":"externalId","required":true,"in":"path","description":"Integration identifier. This value can be the ID from another service (i.e., Salesforce, SAP or SIAGRI)","example":"ab123cd","schema":{"type":"string"}},{"name":"force","required":false,"in":"query","description":"Se `true` a entidade será excluída permanente do banco de dados, no entanto, se houve alguma outra entidade utilizando o registro ele não será removido, caso contrário, será realizado apenas a atualização da entidade para ser desativada.","example":false,"schema":{"default":false,"type":"boolean"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactResponse"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}}},"tags":["customers"],"security":[{"bearer":[]}]}},"/drivers":{"post":{"operationId":"DriverController_create","summary":"[POST] drivers","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDriverDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactResponse"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}}},"tags":["drivers"],"security":[{"bearer":[]}]}},"/drivers/{externalId}":{"get":{"operationId":"DriverController_findOne","summary":"[GET] drivers","parameters":[{"name":"externalId","required":true,"in":"path","description":"Integration identifier. This value can be the ID from another service (i.e., Salesforce, SAP or SIAGRI)","example":"ab123cd","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactResponse"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}}},"tags":["drivers"],"security":[{"bearer":[]}]},"put":{"operationId":"DriverController_update","summary":"[PUT] drivers","parameters":[{"name":"externalId","required":true,"in":"path","description":"Integration identifier. This value can be the ID from another service (i.e., Salesforce, SAP or SIAGRI)","example":"ab123cd","schema":{"type":"string"}},{"name":"upsert","required":false,"in":"query","description":"Se `true` a entidade deve ser criada se não existir, caso contrário, será realizado apenas a atualização da entidade.","example":false,"schema":{"default":false,"type":"boolean"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateDriverDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactResponse"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}}},"tags":["drivers"],"security":[{"bearer":[]}]},"delete":{"operationId":"DriverController_remove","summary":"[DELETE] drivers","parameters":[{"name":"externalId","required":true,"in":"path","description":"Integration identifier. This value can be the ID from another service (i.e., Salesforce, SAP or SIAGRI)","example":"ab123cd","schema":{"type":"string"}},{"name":"force","required":false,"in":"query","description":"Se `true` a entidade será excluída permanente do banco de dados, no entanto, se houve alguma outra entidade utilizando o registro ele não será removido, caso contrário, será realizado apenas a atualização da entidade para ser desativada.","example":false,"schema":{"default":false,"type":"boolean"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactResponse"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}}},"tags":["drivers"],"security":[{"bearer":[]}]}},"/groups":{"post":{"operationId":"GroupsController_create","summary":"[POST] groups","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGroupDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGroupDto"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}}},"tags":["groups"],"security":[{"bearer":[]}]}},"/groups/{externalId}":{"get":{"operationId":"GroupsController_findOne","summary":"[GET] groups","parameters":[{"name":"externalId","required":true,"in":"path","description":"Integration identifier. This value can be the ID from another service (i.e., Salesforce, SAP or SIAGRI)","example":"ab123cd","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGroupDto"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}}},"tags":["groups"],"security":[{"bearer":[]}]},"put":{"operationId":"GroupsController_update","summary":"[PUT] groups","parameters":[{"name":"externalId","required":true,"in":"path","description":"Integration identifier. This value can be the ID from another service (i.e., Salesforce, SAP or SIAGRI)","example":"ab123cd","schema":{"type":"string"}},{"name":"upsert","required":false,"in":"query","description":"Se `true` a entidade deve ser criada se não existir, caso contrário, será realizado apenas a atualização da entidade.","example":false,"schema":{"default":false,"type":"boolean"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateGroupDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGroupDto"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}}},"tags":["groups"],"security":[{"bearer":[]}]},"delete":{"operationId":"GroupsController_remove","summary":"[DELETE] groups","parameters":[{"name":"externalId","required":true,"in":"path","description":"Integration identifier. This value can be the ID from another service (i.e., Salesforce, SAP or SIAGRI)","example":"ab123cd","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGroupDto"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}}},"tags":["groups"],"security":[{"bearer":[]}]}},"/periods":{"post":{"operationId":"PeriodsController_create","summary":"[POST] periods","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePeriodDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePeriodDto"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}}},"tags":["periods"],"security":[{"bearer":[]}]}},"/periods/{externalId}":{"get":{"operationId":"PeriodsController_findOne","summary":"[GET] periods","parameters":[{"name":"externalId","required":true,"in":"path","description":"Integration identifier. This value can be the ID from another service (i.e., Salesforce, SAP or SIAGRI)","example":"ab123cd","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePeriodDto"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}}},"tags":["periods"],"security":[{"bearer":[]}]},"put":{"operationId":"PeriodsController_update","summary":"[PUT] periods","parameters":[{"name":"externalId","required":true,"in":"path","description":"Integration identifier. This value can be the ID from another service (i.e., Salesforce, SAP or SIAGRI)","example":"ab123cd","schema":{"type":"string"}},{"name":"upsert","required":false,"in":"query","description":"Se `true` a entidade deve ser criada se não existir, caso contrário, será realizado apenas a atualização da entidade.","example":false,"schema":{"default":false,"type":"boolean"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePeriodDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePeriodDto"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}}},"tags":["periods"],"security":[{"bearer":[]}]},"delete":{"operationId":"PeriodsController_remove","summary":"[DELETE] periods","parameters":[{"name":"externalId","required":true,"in":"path","description":"Integration identifier. This value can be the ID from another service (i.e., Salesforce, SAP or SIAGRI)","example":"ab123cd","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePeriodDto"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}}},"tags":["periods"],"security":[{"bearer":[]}]}},"/products":{"post":{"operationId":"ProductController_create","summary":"[POST] products","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductDto"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}}},"tags":["products"],"security":[{"bearer":[]}]}},"/products/{externalId}":{"get":{"operationId":"ProductController_findOne","summary":"[GET] products","parameters":[{"name":"externalId","required":true,"in":"path","description":"Integration identifier. This value can be the ID from another service (i.e., Salesforce, SAP or SIAGRI)","example":"ab123cd","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductDto"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}}},"tags":["products"],"security":[{"bearer":[]}]},"put":{"operationId":"ProductController_update","summary":"[PUT] products","parameters":[{"name":"externalId","required":true,"in":"path","description":"Integration identifier. This value can be the ID from another service (i.e., Salesforce, SAP or SIAGRI)","example":"ab123cd","schema":{"type":"string"}},{"name":"upsert","required":false,"in":"query","description":"Se `true` a entidade deve ser criada se não existir, caso contrário, será realizado apenas a atualização da entidade.","example":false,"schema":{"default":false,"type":"boolean"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateProductDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductDto"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}}},"tags":["products"],"security":[{"bearer":[]}]},"delete":{"operationId":"ProductController_remove","summary":"[DELETE] products","parameters":[{"name":"externalId","required":true,"in":"path","description":"Integration identifier. This value can be the ID from another service (i.e., Salesforce, SAP or SIAGRI)","example":"ab123cd","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductDto"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}}},"tags":["products"],"security":[{"bearer":[]}]}},"/product-varieties":{"post":{"operationId":"ProductVarietyController_create","summary":"[POST] product-varieties","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateProductVarietyDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateProductVarietyDto"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}}},"tags":["product-varieties"],"security":[{"bearer":[]}]}},"/product-varieties/{externalId}":{"get":{"operationId":"ProductVarietyController_findOne","summary":"[GET] product-varieties","parameters":[{"name":"externalId","required":true,"in":"path","description":"Integration identifier. This value can be the ID from another service (i.e., Salesforce, SAP or SIAGRI)","example":"ab123cd","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateProductVarietyDto"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}}},"tags":["product-varieties"],"security":[{"bearer":[]}]},"put":{"operationId":"ProductVarietyController_update","summary":"[PUT] product-varieties","parameters":[{"name":"externalId","required":true,"in":"path","description":"Integration identifier. This value can be the ID from another service (i.e., Salesforce, SAP or SIAGRI)","example":"ab123cd","schema":{"type":"string"}},{"name":"upsert","required":false,"in":"query","description":"Se `true` a entidade deve ser criada se não existir, caso contrário, será realizado apenas a atualização da entidade.","example":false,"schema":{"default":false,"type":"boolean"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateProductVarietyDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateProductVarietyDto"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}}},"tags":["product-varieties"],"security":[{"bearer":[]}]},"delete":{"operationId":"ProductVarietyController_remove","summary":"[DELETE] product-varieties","parameters":[{"name":"externalId","required":true,"in":"path","description":"Integration identifier. This value can be the ID from another service (i.e., Salesforce, SAP or SIAGRI)","example":"ab123cd","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateProductVarietyDto"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}}},"tags":["product-varieties"],"security":[{"bearer":[]}]}},"/regionals":{"post":{"operationId":"RegionalController_create","summary":"[POST] regionals","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRegionalDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRegionalDto"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}}},"tags":["regionals"],"security":[{"bearer":[]}]}},"/regionals/{externalId}":{"get":{"operationId":"RegionalController_findOne","summary":"[GET] regionals","parameters":[{"name":"externalId","required":true,"in":"path","description":"Integration identifier. This value can be the ID from another service (i.e., Salesforce, SAP or SIAGRI)","example":"ab123cd","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRegionalDto"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}}},"tags":["regionals"],"security":[{"bearer":[]}]},"put":{"operationId":"RegionalController_update","summary":"[PUT] regionals","parameters":[{"name":"externalId","required":true,"in":"path","description":"Integration identifier. This value can be the ID from another service (i.e., Salesforce, SAP or SIAGRI)","example":"ab123cd","schema":{"type":"string"}},{"name":"upsert","required":false,"in":"query","description":"Se `true` a entidade deve ser criada se não existir, caso contrário, será realizado apenas a atualização da entidade.","example":false,"schema":{"default":false,"type":"boolean"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateRegionalDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRegionalDto"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}}},"tags":["regionals"],"security":[{"bearer":[]}]},"delete":{"operationId":"RegionalController_remove","summary":"[DELETE] regionals","parameters":[{"name":"externalId","required":true,"in":"path","description":"Integration identifier. This value can be the ID from another service (i.e., Salesforce, SAP or SIAGRI)","example":"ab123cd","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRegionalDto"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}}},"tags":["regionals"],"security":[{"bearer":[]}]}},"/sellers":{"post":{"operationId":"SellerController_create","summary":"[POST] sellers","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSellerDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactResponse"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}}},"tags":["sellers"],"security":[{"bearer":[]}]}},"/sellers/{externalId}":{"get":{"operationId":"SellerController_findOne","summary":"[GET] sellers","parameters":[{"name":"externalId","required":true,"in":"path","description":"Integration identifier. This value can be the ID from another service (i.e., Salesforce, SAP or SIAGRI)","example":"ab123cd","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactResponse"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}}},"tags":["sellers"],"security":[{"bearer":[]}]},"put":{"operationId":"SellerController_update","summary":"[PUT] sellers","parameters":[{"name":"externalId","required":true,"in":"path","description":"Integration identifier. This value can be the ID from another service (i.e., Salesforce, SAP or SIAGRI)","example":"ab123cd","schema":{"type":"string"}},{"name":"upsert","required":false,"in":"query","description":"Se `true` a entidade deve ser criada se não existir, caso contrário, será realizado apenas a atualização da entidade.","example":false,"schema":{"default":false,"type":"boolean"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSellerDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactResponse"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}}},"tags":["sellers"],"security":[{"bearer":[]}]},"delete":{"operationId":"SellerController_remove","summary":"[DELETE] sellers","parameters":[{"name":"externalId","required":true,"in":"path","description":"Integration identifier. This value can be the ID from another service (i.e., Salesforce, SAP or SIAGRI)","example":"ab123cd","schema":{"type":"string"}},{"name":"force","required":false,"in":"query","description":"Se `true` a entidade será excluída permanente do banco de dados, no entanto, se houve alguma outra entidade utilizando o registro ele não será removido, caso contrário, será realizado apenas a atualização da entidade para ser desativada.","example":false,"schema":{"default":false,"type":"boolean"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactResponse"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}}},"tags":["sellers"],"security":[{"bearer":[]}]}},"/suppliers":{"post":{"operationId":"SupplierController_create","summary":"[POST] sellers","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSupplierDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactResponse"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}}},"tags":["suppliers"],"security":[{"bearer":[]}]}},"/suppliers/{externalId}":{"get":{"operationId":"SupplierController_findOne","summary":"[GET] sellers","parameters":[{"name":"externalId","required":true,"in":"path","description":"Integration identifier. This value can be the ID from another service (i.e., Salesforce, SAP or SIAGRI)","example":"ab123cd","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactResponse"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}}},"tags":["suppliers"],"security":[{"bearer":[]}]},"put":{"operationId":"SupplierController_update","summary":"[PUT] sellers","parameters":[{"name":"externalId","required":true,"in":"path","description":"Integration identifier. This value can be the ID from another service (i.e., Salesforce, SAP or SIAGRI)","example":"ab123cd","schema":{"type":"string"}},{"name":"upsert","required":false,"in":"query","description":"Se `true` a entidade deve ser criada se não existir, caso contrário, será realizado apenas a atualização da entidade.","example":false,"schema":{"default":false,"type":"boolean"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSupplierDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactResponse"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}}},"tags":["suppliers"],"security":[{"bearer":[]}]},"delete":{"operationId":"SupplierController_remove","summary":"[DELETE] sellers","parameters":[{"name":"externalId","required":true,"in":"path","description":"Integration identifier. This value can be the ID from another service (i.e., Salesforce, SAP or SIAGRI)","example":"ab123cd","schema":{"type":"string"}},{"name":"force","required":false,"in":"query","description":"Se `true` a entidade será excluída permanente do banco de dados, no entanto, se houve alguma outra entidade utilizando o registro ele não será removido, caso contrário, será realizado apenas a atualização da entidade para ser desativada.","example":false,"schema":{"default":false,"type":"boolean"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactResponse"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}}},"tags":["suppliers"],"security":[{"bearer":[]}]}},"/transport-companies":{"post":{"operationId":"TransportCompanyController_create","summary":"[POST] transport-companies","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTransportCompanyDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactResponse"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}}},"tags":["transport-companies"],"security":[{"bearer":[]}]}},"/transport-companies/{externalId}":{"get":{"operationId":"TransportCompanyController_findOne","summary":"[GET] transport-companies","parameters":[{"name":"externalId","required":true,"in":"path","description":"Integration identifier. This value can be the ID from another service (i.e., Salesforce, SAP or SIAGRI)","example":"ab123cd","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactResponse"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}}},"tags":["transport-companies"],"security":[{"bearer":[]}]},"put":{"operationId":"TransportCompanyController_update","summary":"[PUT] transport-companies","parameters":[{"name":"externalId","required":true,"in":"path","description":"Integration identifier. This value can be the ID from another service (i.e., Salesforce, SAP or SIAGRI)","example":"ab123cd","schema":{"type":"string"}},{"name":"upsert","required":false,"in":"query","description":"Se `true` a entidade deve ser criada se não existir, caso contrário, será realizado apenas a atualização da entidade.","example":false,"schema":{"default":false,"type":"boolean"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTransportCompanyDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactResponse"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}}},"tags":["transport-companies"],"security":[{"bearer":[]}]},"delete":{"operationId":"TransportCompanyController_remove","summary":"[DELETE] transport-companies","parameters":[{"name":"externalId","required":true,"in":"path","description":"Integration identifier. This value can be the ID from another service (i.e., Salesforce, SAP or SIAGRI)","example":"ab123cd","schema":{"type":"string"}},{"name":"force","required":false,"in":"query","description":"Se `true` a entidade será excluída permanente do banco de dados, no entanto, se houve alguma outra entidade utilizando o registro ele não será removido, caso contrário, será realizado apenas a atualização da entidade para ser desativada.","example":false,"schema":{"default":false,"type":"boolean"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactResponse"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}}},"tags":["transport-companies"],"security":[{"bearer":[]}]}},"/truck-types":{"post":{"operationId":"TruckTypeController_create","summary":"[POST] truck-types","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTruckTypeDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTruckTypeDto"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}}},"tags":["truck-types"],"security":[{"bearer":[]}]}},"/truck-types/{externalId}":{"get":{"operationId":"TruckTypeController_findOne","summary":"[GET] truck-types","parameters":[{"name":"externalId","required":true,"in":"path","description":"Integration identifier. This value can be the ID from another service (i.e., Salesforce, SAP or SIAGRI)","example":"ab123cd","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTruckTypeDto"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}}},"tags":["truck-types"],"security":[{"bearer":[]}]},"put":{"operationId":"TruckTypeController_update","summary":"[PUT] truck-types","parameters":[{"name":"externalId","required":true,"in":"path","description":"Integration identifier. This value can be the ID from another service (i.e., Salesforce, SAP or SIAGRI)","example":"ab123cd","schema":{"type":"string"}},{"name":"upsert","required":false,"in":"query","description":"Se `true` a entidade deve ser criada se não existir, caso contrário, será realizado apenas a atualização da entidade.","example":false,"schema":{"default":false,"type":"boolean"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTruckTypeDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTruckTypeDto"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}}},"tags":["truck-types"],"security":[{"bearer":[]}]},"delete":{"operationId":"TruckTypeController_remove","summary":"[DELETE] truck-types","parameters":[{"name":"externalId","required":true,"in":"path","description":"Integration identifier. This value can be the ID from another service (i.e., Salesforce, SAP or SIAGRI)","example":"ab123cd","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTruckTypeDto"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}}},"tags":["truck-types"],"security":[{"bearer":[]}]}},"/vehicles":{"post":{"operationId":"VehicleController_create","summary":"[POST] vehicles","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateVehicleDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateVehicleDto"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}}},"tags":["vehicles"],"security":[{"bearer":[]}]}},"/vehicles/{externalId}":{"get":{"operationId":"VehicleController_findOne","summary":"[GET] vehicles","parameters":[{"name":"externalId","required":true,"in":"path","description":"Integration identifier. This value can be the ID from another service (i.e., Salesforce, SAP or SIAGRI)","example":"ab123cd","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateVehicleDto"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}}},"tags":["vehicles"],"security":[{"bearer":[]}]},"put":{"operationId":"VehicleController_update","summary":"[PUT] vehicles","parameters":[{"name":"externalId","required":true,"in":"path","description":"Integration identifier. This value can be the ID from another service (i.e., Salesforce, SAP or SIAGRI)","example":"ab123cd","schema":{"type":"string"}},{"name":"upsert","required":false,"in":"query","description":"Se `true` a entidade deve ser criada se não existir, caso contrário, será realizado apenas a atualização da entidade.","example":false,"schema":{"default":false,"type":"boolean"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateVehicleDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateVehicleDto"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}}},"tags":["vehicles"],"security":[{"bearer":[]}]},"delete":{"operationId":"VehicleController_remove","summary":"[DELETE] vehicles","parameters":[{"name":"externalId","required":true,"in":"path","description":"Integration identifier. This value can be the ID from another service (i.e., Salesforce, SAP or SIAGRI)","example":"ab123cd","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateVehicleDto"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}}},"tags":["vehicles"],"security":[{"bearer":[]}]}},"/withdrawal-places":{"post":{"operationId":"WithdrawalPlaceController_create","summary":"[POST] withdrawal-places","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWithdrawalPlaceDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactResponse"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}}},"tags":["withdrawal-places"],"security":[{"bearer":[]}]}},"/withdrawal-places/{externalId}":{"get":{"operationId":"WithdrawalPlaceController_findOne","summary":"[GET] withdrawal-places","parameters":[{"name":"externalId","required":true,"in":"path","description":"Integration identifier. This value can be the ID from another service (i.e., Salesforce, SAP or SIAGRI)","example":"ab123cd","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactResponse"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}}},"tags":["withdrawal-places"],"security":[{"bearer":[]}]},"put":{"operationId":"WithdrawalPlaceController_update","summary":"[PUT] withdrawal-places","parameters":[{"name":"externalId","required":true,"in":"path","description":"Integration identifier. This value can be the ID from another service (i.e., Salesforce, SAP or SIAGRI)","example":"ab123cd","schema":{"type":"string"}},{"name":"upsert","required":false,"in":"query","description":"Se `true` a entidade deve ser criada se não existir, caso contrário, será realizado apenas a atualização da entidade.","example":false,"schema":{"default":false,"type":"boolean"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateWithdrawalPlaceDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactResponse"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}}},"tags":["withdrawal-places"],"security":[{"bearer":[]}]},"delete":{"operationId":"WithdrawalPlaceController_remove","summary":"[DELETE] withdrawal-places","parameters":[{"name":"externalId","required":true,"in":"path","description":"Integration identifier. This value can be the ID from another service (i.e., Salesforce, SAP or SIAGRI)","example":"ab123cd","schema":{"type":"string"}},{"name":"force","required":false,"in":"query","description":"Se `true` a entidade será excluída permanente do banco de dados, no entanto, se houve alguma outra entidade utilizando o registro ele não será removido, caso contrário, será realizado apenas a atualização da entidade para ser desativada.","example":false,"schema":{"default":false,"type":"boolean"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactResponse"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}}},"tags":["withdrawal-places"],"security":[{"bearer":[]}]}},"/deposits":{"post":{"operationId":"DepositController_create","summary":"[POST] deposits","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DepositDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactResponse"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}}},"tags":["deposits"],"security":[{"bearer":[]}]}},"/deposits/{externalId}":{"get":{"operationId":"DepositController_findOne","summary":"[GET] deposits","parameters":[{"name":"externalId","required":true,"in":"path","description":"Integration identifier. This value can be the ID from another service (i.e., Salesforce, SAP or SIAGRI)","example":"ab123cd","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactResponse"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}}},"tags":["deposits"],"security":[{"bearer":[]}]},"put":{"operationId":"DepositController_update","summary":"[PUT] deposits","parameters":[{"name":"externalId","required":true,"in":"path","description":"Integration identifier. This value can be the ID from another service (i.e., Salesforce, SAP or SIAGRI)","example":"ab123cd","schema":{"type":"string"}},{"name":"upsert","required":false,"in":"query","description":"Se `true` a entidade deve ser criada se não existir, caso contrário, será realizado apenas a atualização da entidade.","example":false,"schema":{"default":false,"type":"boolean"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateDepositDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactResponse"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}}},"tags":["deposits"],"security":[{"bearer":[]}]},"delete":{"operationId":"DepositController_remove","summary":"[DELETE] deposits","parameters":[{"name":"externalId","required":true,"in":"path","description":"Integration identifier. This value can be the ID from another service (i.e., Salesforce, SAP or SIAGRI)","example":"ab123cd","schema":{"type":"string"}},{"name":"force","required":false,"in":"query","description":"Se `true` a entidade será excluída permanente do banco de dados, no entanto, se houve alguma outra entidade utilizando o registro ele não será removido, caso contrário, será realizado apenas a atualização da entidade para ser desativada.","example":false,"schema":{"default":false,"type":"boolean"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactResponse"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}}},"tags":["deposits"],"security":[{"bearer":[]}]}},"/salesteam":{"post":{"operationId":"SalesTeamController_create","summary":"[POST] salesteam","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSalesTeamDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSalesTeamDto"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}}},"tags":["salesteam"],"security":[{"bearer":[]}]}},"/salesteam/{externalId}":{"get":{"operationId":"SalesTeamController_findOne","summary":"[GET] salesteam","parameters":[{"name":"externalId","required":true,"in":"path","description":"Integration identifier. This value can be the ID from another service (i.e., Salesforce, SAP or SIAGRI)","example":"ab123cd","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSalesTeamDto"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}}},"tags":["salesteam"],"security":[{"bearer":[]}]},"put":{"operationId":"SalesTeamController_update","summary":"[PUT] salesteam","parameters":[{"name":"externalId","required":true,"in":"path","description":"Integration identifier. This value can be the ID from another service (i.e., Salesforce, SAP or SIAGRI)","example":"ab123cd","schema":{"type":"string"}},{"name":"upsert","required":false,"in":"query","description":"Se `true` a entidade deve ser criada se não existir, caso contrário, será realizado apenas a atualização da entidade.","example":false,"schema":{"default":false,"type":"boolean"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSalesTeamDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSalesTeamDto"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}}},"tags":["salesteam"],"security":[{"bearer":[]}]},"delete":{"operationId":"SalesTeamController_remove","summary":"[DELETE] salesteam","parameters":[{"name":"externalId","required":true,"in":"path","description":"Integration identifier. This value can be the ID from another service (i.e., Salesforce, SAP or SIAGRI)","example":"ab123cd","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSalesTeamDto"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}}},"tags":["salesteam"],"security":[{"bearer":[]}]}},"/invoices":{"post":{"operationId":"InvoiceController_attachFile","summary":"[POST] invoices","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceAttachFileDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceAttachFileOutDto"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}}},"tags":["invoices"],"security":[{"bearer":[]}]},"delete":{"operationId":"InvoiceController_attachDelete","summary":"[DELETE] invoices","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceAttachFileDeleteDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceAttachFileOutDto"}}}},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}}},"tags":["invoices"],"security":[{"bearer":[]}]}},"/cargos/{idInc}/pdf":{"get":{"operationId":"CargoController_findOne","summary":"[GET] cargos","parameters":[{"name":"idInc","required":true,"in":"path","description":"Cargo identifier","example":"13563","schema":{"type":"string"}}],"responses":{"200":{"description":"PDF file"},"400":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}},"application/pdf":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenResponse"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}},"application/pdf":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}}},"tags":["cargos"],"security":[{"bearer":[]}]}}}}