erpx

2.0info: 1.4.1 Foundation description: Foundation x-senior-domain: ERPX – Foundation para integração x-senior-domain-path: erpx x-senior-service-path: foundation contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: api.senior.com.br /erpx/foundation/securityDefinitions: bearerAuth: type: apiKey in: header name: Authorization – application/json – application/jsonpaths: /branchCreated: post: description: Event of branch create x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – name: input in: body required: true schema: #/definitions/branch responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /branchDeleted: post: description: Event of branch delete x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – name: input in: body required: true schema: #/definitions/branch responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /branchMerged: post: description: Event of branch merge x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – name: input in: body required: true schema: #/definitions/branch responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /branchUpdated: post: description: Event of branch update x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – name: input in: body required: true schema: #/definitions/branch responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /companyCreated: post: description: Event of company create x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – name: input in: body required: true schema: #/definitions/company responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /companyDeleted: post: description: Event of company delete x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – name: input in: body required: true schema: #/definitions/company responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /companyMerged: post: description: Event of company merge x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – name: input in: body required: true schema: #/definitions/company responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /companyUpdated: post: description: Event of company update x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – name: input in: body required: true schema: #/definitions/company responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /productCreated: post: description: Event of product create x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – name: input in: body required: true schema: #/definitions/product responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /productDeleted: post: description: Event of product delete x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – name: input in: body required: true schema: #/definitions/product responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /productMerged: post: description: Event of product merge x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – name: input in: body required: true schema: #/definitions/product responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /productUpdated: post: description: Event of product update x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – name: input in: body required: true schema: #/definitions/product responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /personCreated: post: description: Event of person create x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – name: input in: body required: true schema: #/definitions/person responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /personDeleted: post: description: Event of person delete x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – name: input in: body required: true schema: #/definitions/person responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /personMerged: post: description: Event of person merge x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – name: input in: body required: true schema: #/definitions/person responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /personUpdated: post: description: Event of person update x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – name: input in: body required: true schema: #/definitions/person responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /serviceitemCreated: post: description: Event of serviceitem create x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – name: input in: body required: true schema: #/definitions/serviceitem responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /serviceitemDeleted: post: description: Event of serviceitem delete x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – name: input in: body required: true schema: #/definitions/serviceitem responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /serviceitemMerged: post: description: Event of serviceitem merge x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – name: input in: body required: true schema: #/definitions/serviceitem responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /serviceitemUpdated: post: description: Event of serviceitem update x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – name: input in: body required: true schema: #/definitions/serviceitem responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /familyCreated: post: description: Event of family create x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – name: input in: body required: true schema: #/definitions/family responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /familyDeleted: post: description: Event of family delete x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – name: input in: body required: true schema: #/definitions/family responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /familyMerged: post: description: Event of family merge x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – name: input in: body required: true schema: #/definitions/family responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /familyUpdated: post: description: Event of family update x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – name: input in: body required: true schema: #/definitions/family responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /paymenttermsCreated: post: description: Event of paymentTerms create x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – name: input in: body required: true schema: #/definitions/paymentTerms responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /paymenttermsDeleted: post: description: Event of paymentTerms delete x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – name: input in: body required: true schema: #/definitions/paymentTerms responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /paymenttermsMerged: post: description: Event of paymentTerms merge x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – name: input in: body required: true schema: #/definitions/paymentTerms responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /paymenttermsUpdated: post: description: Event of paymentTerms update x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – name: input in: body required: true schema: #/definitions/paymentTerms responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /paymenttermsinstallmentCreated: post: description: Event of paymentTermsInstallment create x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – name: input in: body required: true schema: #/definitions/paymentTermsInstallment responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /paymenttermsinstallmentDeleted: post: description: Event of paymentTermsInstallment delete x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – name: input in: body required: true schema: #/definitions/paymentTermsInstallment responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /paymenttermsinstallmentMerged: post: description: Event of paymentTermsInstallment merge x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – name: input in: body required: true schema: #/definitions/paymentTermsInstallment responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /paymenttermsinstallmentUpdated: post: description: Event of paymentTermsInstallment update x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – name: input in: body required: true schema: #/definitions/paymentTermsInstallment responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /paymentmethodCreated: post: description: Event of paymentMethod create x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – name: input in: body required: true schema: #/definitions/paymentMethod responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /paymentmethodDeleted: post: description: Event of paymentMethod delete x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – name: input in: body required: true schema: #/definitions/paymentMethod responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /paymentmethodMerged: post: description: Event of paymentMethod merge x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – name: input in: body required: true schema: #/definitions/paymentMethod responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /paymentmethodUpdated: post: description: Event of paymentMethod update x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – name: input in: body required: true schema: #/definitions/paymentMethod responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /customerdefinitionCreated: post: description: Event of customerDefinition create x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – name: input in: body required: true schema: #/definitions/customerDefinition responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /customerdefinitionDeleted: post: description: Event of customerDefinition delete x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – name: input in: body required: true schema: #/definitions/customerDefinition responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /customerdefinitionMerged: post: description: Event of customerDefinition merge x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – name: input in: body required: true schema: #/definitions/customerDefinition responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /customerdefinitionUpdated: post: description: Event of customerDefinition update x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – name: input in: body required: true schema: #/definitions/customerDefinition responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /salepricelistvalidityCreated: post: description: Event of salePriceListValidity create x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – name: input in: body required: true schema: #/definitions/salePriceListValidity responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /salepricelistvalidityDeleted: post: description: Event of salePriceListValidity delete x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – name: input in: body required: true schema: #/definitions/salePriceListValidity responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /salepricelistvalidityMerged: post: description: Event of salePriceListValidity merge x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – name: input in: body required: true schema: #/definitions/salePriceListValidity responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /salepricelistvalidityUpdated: post: description: Event of salePriceListValidity update x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – name: input in: body required: true schema: #/definitions/salePriceListValidity responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /contactCreated: post: description: Event of contact create x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – name: input in: body required: true schema: #/definitions/contact responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /contactDeleted: post: description: Event of contact delete x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – name: input in: body required: true schema: #/definitions/contact responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /contactMerged: post: description: Event of contact merge x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – name: input in: body required: true schema: #/definitions/contact responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /contactUpdated: post: description: Event of contact update x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – name: input in: body required: true schema: #/definitions/contact responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /salepricelistitemCreated: post: description: Event of salePriceListItem create x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – name: input in: body required: true schema: #/definitions/salePriceListItem responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /salepricelistitemDeleted: post: description: Event of salePriceListItem delete x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – name: input in: body required: true schema: #/definitions/salePriceListItem responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /salepricelistitemMerged: post: description: Event of salePriceListItem merge x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – name: input in: body required: true schema: #/definitions/salePriceListItem responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /salepricelistitemUpdated: post: description: Event of salePriceListItem update x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – name: input in: body required: true schema: #/definitions/salePriceListItem responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /brandCreated: post: description: Event of brand create x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – name: input in: body required: true schema: #/definitions/brand responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /brandDeleted: post: description: Event of brand delete x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – name: input in: body required: true schema: #/definitions/brand responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /brandMerged: post: description: Event of brand merge x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – name: input in: body required: true schema: #/definitions/brand responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /brandUpdated: post: description: Event of brand update x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – name: input in: body required: true schema: #/definitions/brand responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/company: post: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/company responses: 200: description: The created resource schema: #/definitions/company default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/company responses: 200: description: The created resource schema: #/definitions/company default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/company default: description: Error response schema: #/definitions/genericError /entities/company/{id}: put: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/company responses: 200: description: Ok schema: #/definitions/company default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/company responses: 200: description: Ok schema: #/definitions/company default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/company default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/company/bulk: post: description: This entity is customizable. tags: – Entities parameters: – name: entities in: body required: true schema: type: array items: #/definitions/company responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/salePriceListItem: post: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/salePriceListItem responses: 200: description: The created resource schema: #/definitions/salePriceListItem default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/salePriceListItem responses: 200: description: The created resource schema: #/definitions/salePriceListItem default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/salePriceListItem default: description: Error response schema: #/definitions/genericError /entities/salePriceListItem/{id}: put: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/salePriceListItem responses: 200: description: Ok schema: #/definitions/salePriceListItem default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/salePriceListItem responses: 200: description: Ok schema: #/definitions/salePriceListItem default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/salePriceListItem default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/salePriceListItem/bulk: post: description: This entity is customizable. tags: – Entities parameters: – name: entities in: body required: true schema: type: array items: #/definitions/salePriceListItem responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/product: post: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/product responses: 200: description: The created resource schema: #/definitions/product default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/product responses: 200: description: The created resource schema: #/definitions/product default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/product default: description: Error response schema: #/definitions/genericError /entities/product/{id}: put: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/product responses: 200: description: Ok schema: #/definitions/product default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/product responses: 200: description: Ok schema: #/definitions/product default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/product default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/product/bulk: post: description: This entity is customizable. tags: – Entities parameters: – name: entities in: body required: true schema: type: array items: #/definitions/product responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/serviceitem: post: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/serviceitem responses: 200: description: The created resource schema: #/definitions/serviceitem default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/serviceitem responses: 200: description: The created resource schema: #/definitions/serviceitem default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/serviceitem default: description: Error response schema: #/definitions/genericError /entities/serviceitem/{id}: put: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/serviceitem responses: 200: description: Ok schema: #/definitions/serviceitem default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/serviceitem responses: 200: description: Ok schema: #/definitions/serviceitem default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/serviceitem default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/serviceitem/bulk: post: description: This entity is customizable. tags: – Entities parameters: – name: entities in: body required: true schema: type: array items: #/definitions/serviceitem responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/paymentTerms: post: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/paymentTerms responses: 200: description: The created resource schema: #/definitions/paymentTerms default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/paymentTerms responses: 200: description: The created resource schema: #/definitions/paymentTerms default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/paymentTerms default: description: Error response schema: #/definitions/genericError /entities/paymentTerms/{id}: put: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/paymentTerms responses: 200: description: Ok schema: #/definitions/paymentTerms default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/paymentTerms responses: 200: description: Ok schema: #/definitions/paymentTerms default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/paymentTerms default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/paymentTerms/bulk: post: description: This entity is customizable. tags: – Entities parameters: – name: entities in: body required: true schema: type: array items: #/definitions/paymentTerms responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/contact: post: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/contact responses: 200: description: The created resource schema: #/definitions/contact default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/contact responses: 200: description: The created resource schema: #/definitions/contact default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/contact default: description: Error response schema: #/definitions/genericError /entities/contact/{id}: put: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/contact responses: 200: description: Ok schema: #/definitions/contact default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/contact responses: 200: description: Ok schema: #/definitions/contact default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/contact default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/contact/bulk: post: description: This entity is customizable. tags: – Entities parameters: – name: entities in: body required: true schema: type: array items: #/definitions/contact responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/brand: post: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/brand responses: 200: description: The created resource schema: #/definitions/brand default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/brand responses: 200: description: The created resource schema: #/definitions/brand default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/brand default: description: Error response schema: #/definitions/genericError /entities/brand/{id}: put: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/brand responses: 200: description: Ok schema: #/definitions/brand default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/brand responses: 200: description: Ok schema: #/definitions/brand default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/brand default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/brand/bulk: post: description: This entity is customizable. tags: – Entities parameters: – name: entities in: body required: true schema: type: array items: #/definitions/brand responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/customerDefinition: post: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/customerDefinition responses: 200: description: The created resource schema: #/definitions/customerDefinition default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/customerDefinition responses: 200: description: The created resource schema: #/definitions/customerDefinition default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/customerDefinition default: description: Error response schema: #/definitions/genericError /entities/customerDefinition/{id}: put: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/customerDefinition responses: 200: description: Ok schema: #/definitions/customerDefinition default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/customerDefinition responses: 200: description: Ok schema: #/definitions/customerDefinition default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/customerDefinition default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/customerDefinition/bulk: post: description: This entity is customizable. tags: – Entities parameters: – name: entities in: body required: true schema: type: array items: #/definitions/customerDefinition responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/salePriceListValidity: post: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/salePriceListValidity responses: 200: description: The created resource schema: #/definitions/salePriceListValidity default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/salePriceListValidity responses: 200: description: The created resource schema: #/definitions/salePriceListValidity default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/salePriceListValidity default: description: Error response schema: #/definitions/genericError /entities/salePriceListValidity/{id}: put: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/salePriceListValidity responses: 200: description: Ok schema: #/definitions/salePriceListValidity default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/salePriceListValidity responses: 200: description: Ok schema: #/definitions/salePriceListValidity default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/salePriceListValidity default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/salePriceListValidity/bulk: post: description: This entity is customizable. tags: – Entities parameters: – name: entities in: body required: true schema: type: array items: #/definitions/salePriceListValidity responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/branch: post: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/branch responses: 200: description: The created resource schema: #/definitions/branch default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/branch responses: 200: description: The created resource schema: #/definitions/branch default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/branch default: description: Error response schema: #/definitions/genericError /entities/branch/{id}: put: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/branch responses: 200: description: Ok schema: #/definitions/branch default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/branch responses: 200: description: Ok schema: #/definitions/branch default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/branch default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/branch/bulk: post: description: This entity is customizable. tags: – Entities parameters: – name: entities in: body required: true schema: type: array items: #/definitions/branch responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/paymentMethod: post: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/paymentMethod responses: 200: description: The created resource schema: #/definitions/paymentMethod default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/paymentMethod responses: 200: description: The created resource schema: #/definitions/paymentMethod default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/paymentMethod default: description: Error response schema: #/definitions/genericError /entities/paymentMethod/{id}: put: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/paymentMethod responses: 200: description: Ok schema: #/definitions/paymentMethod default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/paymentMethod responses: 200: description: Ok schema: #/definitions/paymentMethod default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/paymentMethod default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/paymentMethod/bulk: post: description: This entity is customizable. tags: – Entities parameters: – name: entities in: body required: true schema: type: array items: #/definitions/paymentMethod responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/paymentTermsInstallment: post: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/paymentTermsInstallment responses: 200: description: The created resource schema: #/definitions/paymentTermsInstallment default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/paymentTermsInstallment responses: 200: description: The created resource schema: #/definitions/paymentTermsInstallment default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/paymentTermsInstallment default: description: Error response schema: #/definitions/genericError /entities/paymentTermsInstallment/{id}: put: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/paymentTermsInstallment responses: 200: description: Ok schema: #/definitions/paymentTermsInstallment default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/paymentTermsInstallment responses: 200: description: Ok schema: #/definitions/paymentTermsInstallment default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/paymentTermsInstallment default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/paymentTermsInstallment/bulk: post: description: This entity is customizable. tags: – Entities parameters: – name: entities in: body required: true schema: type: array items: #/definitions/paymentTermsInstallment responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/salePriceList: post: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/salePriceList responses: 200: description: The created resource schema: #/definitions/salePriceList default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/salePriceList responses: 200: description: The created resource schema: #/definitions/salePriceList default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/salePriceList default: description: Error response schema: #/definitions/genericError /entities/salePriceList/{id}: put: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/salePriceList responses: 200: description: Ok schema: #/definitions/salePriceList default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/salePriceList responses: 200: description: Ok schema: #/definitions/salePriceList default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/salePriceList default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/salePriceList/bulk: post: description: This entity is customizable. tags: – Entities parameters: – name: entities in: body required: true schema: type: array items: #/definitions/salePriceList responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/family: post: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/family responses: 200: description: The created resource schema: #/definitions/family default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/family responses: 200: description: The created resource schema: #/definitions/family default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/family default: description: Error response schema: #/definitions/genericError /entities/family/{id}: put: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/family responses: 200: description: Ok schema: #/definitions/family default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/family responses: 200: description: Ok schema: #/definitions/family default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/family default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/family/bulk: post: description: This entity is customizable. tags: – Entities parameters: – name: entities in: body required: true schema: type: array items: #/definitions/family responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/person: post: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/person responses: 200: description: The created resource schema: #/definitions/person default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: entity in: body required: true schema: #/definitions/person responses: 200: description: The created resource schema: #/definitions/person default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/person default: description: Error response schema: #/definitions/genericError /entities/person/{id}: put: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/person responses: 200: description: Ok schema: #/definitions/person default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/person responses: 200: description: Ok schema: #/definitions/person default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/person default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/person/bulk: post: description: This entity is customizable. tags: – Entities parameters: – name: entities in: body required: true schema: type: array items: #/definitions/person responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericErrordefinitions: salePriceList: type: object required: – company – currency – state – code – description – abbreviation – status properties: id: type: string description: format: uuid company: #/definitions/company currency: #/definitions/currency state: #/definitions/state code: type: string description: Código Tabela Preço description: type: string description: Descrição abbreviation: type: string description: Abreviatura status: type: string description: Situação company: type: object required: – code – name – tradeName – country – currency properties: id: type: string description: format: uuid code: type: integer description: Código da empresa name: type: string description: Nome da empresa tradeName: type: string description: Nome fantasia da empresa companyGroup: #/definitions/companyGroup country: #/definitions/country useBranchGrouping: type: boolean description: Utiliza agrupamento filial currency: #/definitions/currency deleted: type: boolean description: Indica se o registro foi excluído companyFiscalCompliance: #/definitions/companyFiscalCompliance companyAccountingCompliance: #/definitions/companyAccountingCompliance companyApportionment: #/definitions/companyApportionment companyGroup: type: object properties: id: type: string description: format: uuid country: type: object properties: id: type: string description: format: uuid currency: type: object properties: id: type: string description: format: uuid companyFiscalCompliance: type: object properties: id: type: string description: format: uuid useFiscalCode: type: boolean description: Utiliza código fiscal productFiscalCodeConfiguration: type: string description: Parâmetro de configuração do código fiscal do produto productFiscalDescriptionConfiguration: type: string description: Parâmetro de configuração da descrição fiscal do produto serviceFiscalCodeConfiguration: type: string description: Parâmetro de configuração do código fiscal do serviço serviceFiscalDescriptionConfiguration: type: string description: Parâmetro de configuração da descrição fiscal do serviço canDuplicateFiscalCode: type: boolean description: Permitir duplicar código fiscal canModifyFiscalCode: type: boolean description: Permitir alterar código e descrição fiscal registerProductMovementsForTaxes: type: boolean description: Registra entrada e saída dos produtos para controle de impostos companyAccountingCompliance: type: object required: – accountingPlanTemplateStatus – secondaryPlanTemplateStatus properties: id: type: string description: format: uuid accountingPlanTemplate: #/definitions/planTemplate secondaryPlanTemplate: #/definitions/planTemplate acceptEntriesWithDifferentBranches: type: boolean description: Aceita lançamentos com filiais diferentes da informada no lote apportionmentOrigin: type: string description: Origem do rateio a ser considerado na contabilização enableCnpjCpf: type: boolean description: Habilitar o campo CNPJ/CPF nos lançamentos contábeis requireCnpjCpf: type: boolean description: Exigir que seja informado o CNPJ/CPF no lançamento contábil generateCustomerCompositionAccount: type: boolean description: Gerar conta de composição auxiliar ao cadastrar o cliente generateCustomerAdvanceCompositionAccount: type: boolean description: Gerar conta de composição auxiliar de adiantamento ao cadastrar o cliente generateSupplierCompositionAccount: type: boolean description: Gerar conta de composição auxiliar ao cadastrar o fornecedor generateSupplierAdvanceCompositionAccount: type: boolean description: Gerar conta de composição auxiliar de adiantamento ao cadastrar o fornecedor generateInternalCompositionAccount: type: boolean description: Gerar conta de composição auxiliar ao cadastrar a conta interna clearEntriesScreen: type: boolean description: Limpar Tela Lançamento accountingPlanTemplateStatus: type: string description: Status da replicação para o modelo de plano contábil accountingPlanTemplateMessage: type: string description: Mensagem de erro da replicação para o modelo de plano contábil secondaryPlanTemplateStatus: type: string description: Status da replicação para o modelo de plano auxiliar secondaryPlanTemplateMessage: type: string description: Mensagem de erro da replicação para o modelo de plano auxiliar planTemplate: type: object properties: id: type: string description: format: uuid companyApportionment: type: object required: – financialPlanTemplateStatus – costCenterPlanTemplateStatus properties: id: type: string description: format: uuid financialPlanTemplate: #/definitions/planTemplate costCenterPlanTemplate: #/definitions/planTemplate enterInventoryMovements: type: boolean description: Lança movimentos de estoque no plano financeiro enterAccountsReceivable: type: boolean description: Lança títulos de previsão do contas a receber no plano financeiro enterAccountsPayable: type: boolean description: Lança títulos de previsão do contas a pagar no plano financeiro suggestLedgerAccount: type: boolean description: Sugere conta contábil no rateio plano financeiro financialPlanTemplateStatus: type: string description: Status da replicação para o modelo de plano financeiro financialPlanTemplateMessage: type: string description: Mensagem de erro da replicação para o modelo de plano financeiro costCenterPlanTemplateStatus: type: string description: Status da replicação para o modelo de plano de centro de custo costCenterPlanTemplateMessage: type: string description: Mensagem de erro da replicação para o modelo de plano de centro de custo state: type: object properties: id: type: string description: format: uuid branch: type: object required: – company – code – name – tradeName properties: id: type: string description: format: uuid company: #/definitions/company code: type: integer description: Filial name: type: string description: Nome tradeName: type: string description: Fantasia businessType: type: string description: Ramo de atividade personType: type: string description: Tipo de pessoa cnpjCpf: type: string description: CPF/CNPJ stateRegistrationNumber: type: string description: Inscrição estadual municipalRegistrationNumber: type: string description: Inscrição municipal municipalRegistrationNumberForServiceInvoice: type: string description: Inscrição municipal NFS fiscalIdNumber: type: string description: Número identificação fiscal freeZone: type: string description: Indicativo de qual o benefício fiscal da filial suframaCode: type: string description: Código da empresa/filial junto a Suframa zipCode: #/definitions/cep address: type: string description: Endereço addressNumber: type: string description: Número addressComplement: type: string description: Complemento neighborhood: type: string description: Bairro city: #/definitions/city cityName: type: string description: Cidade state: #/definitions/state deliveryZipCode: #/definitions/cep deliveryAddress: type: string description: Endereço entrega deliveryAddressNumber: type: string description: Número entrega deliveryAddressComplement: type: string description: Complemento entrega deliveryCity: type: string description: Cidade entrega deliveryState: #/definitions/state billingZipCode: #/definitions/cep billingAddress: type: string description: Endereço cobrança billingAddressNumber: type: string description: Número cobrança billingAddressComplement: type: string description: Complemento cobrança billingNeighborhood: type: string description: Bairro cobrança billingCity: type: string description: Cidade cobrança billingState: #/definitions/state phoneNumber: type: string description: Telefone faxNumber: type: string description: Fax mailbox: type: integer description: Caixa postal email: type: string description: E-mail branchAsAPerson: #/definitions/person activityInitialDate: type: string description: Data início atividade format: date socialObject: type: string description: Objeto social branchGrouping: #/definitions/branchGrouping agentCode: type: integer description: Código do agente installationCode: type: integer description: Código da instalação parentBranch: type: boolean description: Filial matriz deleted: type: boolean description: Indica se o registro foi excluído commercialBranch: #/definitions/commercialBranch salesBranch: #/definitions/salesBranch invoicingBranch: #/definitions/invoicingBranch cep: type: object properties: id: type: string description: format: uuid city: type: object properties: id: type: string description: format: uuid person: type: object required: – code – name – tradeName – personType – marketType properties: id: type: string description: format: uuid code: type: integer description: Código name: type: string description: Nome tradeName: type: string description: Nome fantasia personType: type: string description: Tipo de pessoa documentNumber: type: string description: CNPJ/CPF rgNumber: type: string description: Número do RG rgIssuanceDate: type: string description: Data de emissão do RG format: date rgIssuer: type: string description: Órgão emissor do RG stateRegistration: type: string description: Inscrição estadual municipalRegistration: type: string description: Inscrição municipal useTaxIdentificationNumber: type: string description: Utilização do número de identificação fiscal (NIF) taxIdentificationNumber: type: string description: Número de identificação fiscal (NIF) marketType: type: string description: Tipo de mercado do cliente companyType: type: string description: Tipo de ramo de atividade companyGroup: #/definitions/companyGroup taxBenefit: type: string description: Indicativo de qual o benefício fiscal do cliente suframaCode: type: string description: Código do SUFRAMA suframaValidity: type: string description: Validade do registro do SUFRAMA format: date cep: #/definitions/cep address: type: string description: Endereço addressNumber: type: string description: Número addressComplement: type: string description: Complemento neighborhood: type: string description: Bairro country: #/definitions/country state: #/definitions/state city: #/definitions/city mailbox: type: integer description: Caixa postal zipCode: type: string description: Zip code phoneNumber: type: string description: Telefone phoneNumber2: type: string description: Telefone 2 fax: type: string description: Fax email: type: string description: E-mail emailForElectronicDocuments: type: string description: E-mail para envio de documentos eletrônicos birthDate: type: string description: Data de nascimento format: date customerExpirationDate: type: string description: Vencimento do cadastro do cliente format: date cadastralRenewalsAmount: type: integer description: Quantidade de renovações cadastrais cboNumber: #/definitions/cbo insuredRegistration: type: string description: Número de inscrição do segurado (NIS, NIT e PIS/PASEP) numberOfDependents: type: integer description: Quantidade de dependentes alimonyValue: type: string description: Valor da Pensão judicial/alimentícia caepf: type: string description: Cadastro da atividade econômica da pessoa física (CAEPF) industry: #/definitions/industry status: type: string description: Situação shippingCompany: #/definitions/shippingCompany favored: #/definitions/favored customer: #/definitions/customer representative: #/definitions/representative provider: #/definitions/provider deleted: type: boolean description: Indica se o registro foi excluído cbo: type: object properties: id: type: string description: format: uuid industry: type: object properties: id: type: string description: format: uuid shippingCompany: type: object properties: id: type: string description: format: uuid freightType: type: string description: Indicativo se o frete da transportadora é CIF ou FOB contactName: type: string description: Nome da pessoa de contato na transportadora rntrc: type: string description: Registro nacional de transportadores rodoviários de carga – RNTRC taf: type: string description: Termo de autorização dos serviços em regime de fretamento – TAF registrationNumber: type: string description: Número de registro adquirido junto a administração estadual status: type: string description: Situação da transportadora favored: type: object required: – status properties: id: type: string description: format: uuid bank: #/definitions/bank accountType: type: string description: Tipo de conta bankBranch: #/definitions/bankBranch accountNumber: type: string description: Número da conta corrente do favorecido no banco status: type: string description: Situação do favorecido bank: type: object properties: id: type: string description: format: uuid bankBranch: type: object properties: id: type: string description: format: uuid customer: type: object required: – status properties: id: type: string description: format: uuid status: type: string description: Situação do cliente statusReason: #/definitions/statusReason statusReasonNote: type: string description: Observação do motivo da situação do cliente statusReasonDate: type: string description: Data do motivo da situação do cliente format: date-time statusReasonUser: type: string description: Usuário responsável pelo motivo da situação do cliente propertyRight: type: string description: Tipo do direito de propriedade da empresa brand: type: string description: Marca do cliente roundindType: type: string description: Tipo de acerto (arredondamento) do cliente statusReason: type: object properties: id: type: string description: format: uuid representative: type: object required: – commissionPaymentType – status properties: id: type: string description: format: uuid commissionPaymentType: type: string description: Forma de pagamento da comissão do portador status: type: string description: Situação statusReason: #/definitions/statusReason statusReasonNote: type: string description: Observação do motivo statusReasonUpdateDate: type: string description: Data da alteração do motivo format: date-time statusReasonUpdatedBy: type: string description: Usuário da alteração do motivo provider: type: object required: – status properties: id: type: string description: format: uuid brand: type: string description: Marca propertyRight: type: string description: Tipo do direito de propriedade da empresa website: type: string description: Site useAbntRounding: type: boolean description: Utilizar a regra de arredondamento da ABNT supplierType: type: string description: Tipo do fornecedor status: type: string description: Situação do fornecedor statusReason: #/definitions/statusReason statusReasonNote: type: string description: Observação do motivo da situação do fornecedor statusReasonDate: type: string description: Data do motivo da situação do fornecedor format: date statusReasonUser: type: string description: Usuário responsável pelo motivo da situação do fornecedor branchGrouping: type: object properties: id: type: string description: format: uuid commercialBranch: type: object required: – salesInitialDate – salesFinalDate – freightApportionmentType – statedFreightApportionmentType – insuranceApportionmentType – packagingApportionmentType – chargesApportionmentType – otherValuesApportionmentType – importOtherValuesApportionmentType properties: id: type: string description: format: uuid salesInitialDate: type: string description: Período Inicial de Vendas format: date salesFinalDate: type: string description: Período final de Vendas format: date freightApportionmentType: type: string description: Tipo de Rateio Valor de Frete statedFreightApportionmentType: type: string description: Tipo de Rateio Valor de Frete Destacado insuranceApportionmentType: type: string description: Tipo de Rateio Valor de Seguro packagingApportionmentType: type: string description: Tipo de Rateio Valor de Embalagens chargesApportionmentType: type: string description: Tipo de Rateio Valor de Encargos otherValuesApportionmentType: type: string description: Tipo de Rateio Valor de Outros importOtherValuesApportionmentType: type: string description: Tipo de Rat. Valor de Outras de Importação importFreightApportionmentType: type: string description: Tipo de Rateio Valor de Frete de Importação importInsuranceApportionmentType: type: string description: Tipo de Rateio Valor de Seguros de Importação changePriceOnConversions: type: boolean description: Altera Preço Unit. em Conversões requireCustomerDeliveryAddress: type: boolean description: Obriga Sequência de Entrega do Cliente requireCustomerBillingAddress: type: boolean description: Obriga Sequência de Cobrança do Cliente sellUnrelatedProductToCustomer: type: boolean description: Venda produto não ligado a cliente useAbntRounding: type: boolean description: Utiliza regra arredondamento ABNT buyerPresenceSign: type: string description: Indicativo presencial do consumidor commissionWithoutFinancialValue: type: boolean description: Comissão sem valor financeiro prorateFreightOnIcmsExemptedItems: type: boolean description: Rateia frete em itens isentos de ICMS statedOtherExpensesApportionmentType: type: string description: Tipo de rateio de outras despesas destacado discountApportionmentType: type: string description: Tipo de rateio de desconto dueDateCriterion: type: string description: Critério Vencimento serviceInvoiceAsNfe: type: boolean description: Gerar serviço na NF-e suggestIntermediation: type: boolean description: Sugerir indicativo de intermediação conforme indicativo de presença do comprador salesBranch: type: object properties: id: type: string description: format: uuid minimumOrderValue: type: number description: Valor mínimo pedido format: double allowInvoiceAmountAbove: type: boolean description: Faturar uma quantidade acima da quantidade pedida no item de pedido allowOrderWithoutStock: type: boolean description: Indicativo se aceita item de pedido sem estoque disponível invoicingBranch: type: object properties: id: type: string description: format: uuid defaultInvoiceSerie: #/definitions/serie gtinOrigin: type: string description: Forma de busca do código GTIN para gerar as tags cEAN e cEANTrib invoiceCancellationDeadline: type: integer description: Prazo para cancelamento da nota fiscal eletrônica serviceInvoiceCancellationDeadline: type: integer description: Prazo para cancelamento da nota fiscal de serviço referenceNfceAndCfe: type: boolean description: Indicativo se vai referenciar as NFC-e e CF-e no XML da NF-e caso existir useCommercialQuantity: type: boolean description: Utiliza quantidade comercial no Lote do XML da NF-e nfeLimitValue: type: number description: Valor limite estabelecido pela SEFAZ para NF-e format: double generateVehicleInformationWithinState: type: boolean description: Indicativo se gera as informações de veículos na NF-e em operações dentro da UF generateReferencedInvoiceTag: type: boolean description: Indicativo se gera tag para notas referenciadas de notas fiscais defaultServiceInvoiceSerie: #/definitions/serie allowSubstituteServiceInvoice: type: boolean description: Aceita nota fiscal de serviço substituta detailOtherPayment: type: boolean description: Detalhar o meio de pagamento Outros na NF-e defaultServiceReceiptSerie: #/definitions/serie serie: type: object properties: id: type: string description: format: uuid product: type: object required: – company – family – code – description – status properties: id: type: string description: format: uuid company: #/definitions/company family: #/definitions/family code: type: string description: Código description: type: string description: Descrição additionalDescription: type: string description: Descrição complementar barcode: type: string description: Código de barras freeBarcode: type: string description: Código barras livre gtin: type: string description: GTIN unidade tributável productIdentification: type: string description: Identificação produto grossWeight: type: number description: Peso bruto format: double netWeight: type: number description: Peso líquido format: double referenceCode: type: string description: Código da Referência spendingNature: #/definitions/spendingNature status: type: string description: Situação statusReason: #/definitions/statusReason productFramework: type: string description: Enquadramento de produto específico deleted: type: boolean description: Indica se o registro foi excluído commercialProduct: #/definitions/commercialProduct taxProduct: #/definitions/taxProduct stockProduct: #/definitions/stockProduct purchaseProduct: #/definitions/purchaseProduct apportionmentProduct: #/definitions/apportionmentProduct family: type: object required: – company – code – description – origin – productCodeSize – isKit properties: id: type: string description: format: uuid company: #/definitions/company code: type: string description: Código description: type: string description: Descrição origin: #/definitions/origin productCodeSize: type: integer description: Quantidade de posições para o código de produto originLevelNumber: type: integer description: Número do nível da origem do produto isKit: type: boolean description: Indicativo que os produtos produzidos desta família são 'kit' c/ vários produtos agregados p/ venda (não gera op) brand: #/definitions/brand requireMounting: type: string description: Indicativo se o produto exige montagem status: type: string description: Situação productType: type: string description: Tipo produto spendingNature: #/definitions/spendingNature deleted: type: boolean description: Indica se o registro foi excluído commercialFamily: #/definitions/commercialFamily supplyFamily: #/definitions/supplyFamily apportionmentFamily: #/definitions/apportionmentFamily fiscalFamily: #/definitions/fiscalFamily origin: type: object properties: id: type: string description: format: uuid brand: type: object required: – code – name – status properties: id: type: string description: format: uuid code: type: string description: Código da marca/etiqueta vinculada a um produto ou a um pedido name: type: string description: Nome da marca status: type: string description: Situação da marca deleted: type: boolean description: Indica se o registro foi excluído spendingNature: type: object properties: id: type: string description: format: uuid commercialFamily: type: object properties: id: type: string description: format: uuid groupingSalesQuotas: #/definitions/groupingSalesQuotas salePriceDecimals: type: integer description: Decimais Preço Venda gtinOrigin: type: string description: Origem do código GTIN groupingSalesQuotas: type: object properties: id: type: string description: format: uuid supplyFamily: type: object required: – measureUnit properties: id: type: string description: format: uuid useSeries: type: boolean description: Controla Série ? useBatch: type: boolean description: Controla Lote ? dueDateControll: type: string description: Controle validade measureUnit: #/definitions/measureUnit measureUnit: type: object properties: id: type: string description: format: uuid apportionmentFamily: type: object properties: id: type: string description: format: uuid expenseAccount: #/definitions/account revenueAccount: #/definitions/account inventoryLedgerAccount: #/definitions/account directCostAccount: #/definitions/account account5: #/definitions/account indirectCostAccount: #/definitions/account revenueFinancialAccount: #/definitions/financialAccount expenseFinancialAccount: #/definitions/financialAccount account: type: object properties: id: type: string description: format: uuid financialAccount: type: object properties: id: type: string description: format: uuid fiscalFamily: type: object properties: id: type: string description: format: uuid ncm: #/definitions/ncm productTypeForTaxes: type: string description: Tipo Produto para Impostos controlsPeps: type: boolean description: Controla PEPs ncm: type: object properties: id: type: string description: format: uuid commercialProduct: type: object properties: id: type: string description: format: uuid gtinCodeSearchType: type: string description: Forma de busca do código GTIN para gerar as tags cEAN e cEANTrib groupingSalesQuotas: #/definitions/groupingSalesQuotas baseQuantityForPriceCalculation: type: number description: Quantidade Base para Cálculo de Preço format: double productSoldSeparately: type: boolean description: Produto vendido separadamente? anvisaRegistrationNumber: type: string description: Número registro Anvisa reasonForAnvisaExemption: type: string description: Motivo da isenção da Anvisa productCanBeSold: type: boolean description: Indicativo se o produto pode ser vendido productPerCustomer: type: boolean description: Produto por Cliente multiSalesQuantity: type: number description: Quantidade Múltipla Vendas format: double priceGrouping: type: string description: Agrupamento Preço commissioned: type: boolean description: Comissionado ? measureUnitPriceCalculation: type: string description: Unidade Medida (Cálculo de preço) percentageNaturalGas: type: number description: % Gás Natural format: double customProduct: type: boolean description: Produto Sob Encomenda percentageInGLPProduct: type: number description: Percentual do GLP derivado do petróleo no produto GLP format: double percentageOfImportedNaturalGas: type: number description: Percentual de Gás Natural Importado – GLGNi para o produto GLP format: double measureUnit: #/definitions/measureUnit invoiceDescription: type: string description: Descrição p/ Nota Fiscal additionalInformationForInvoice: type: string description: Informações adicionais do produto para NF-e taxProduct: type: object properties: id: type: string description: format: uuid taxCode: type: string description: Código fiscal taxDescription: type: string description: Descrição fiscal ncm: #/definitions/ncm taxProductType: type: string description: Tipo Produto para Impostos productCodeForANP: type: integer description: Código de produto ANP productDescriptionForANP: type: string description: Descrição do produto conforme ANP taxOriginOfGoods: type: string description: Origem fiscal da mercadoria cest: type: string description: Especificador substituição tributária generateTransferGroupWithCST60: type: boolean description: Gerar grupo de repasse de ICMS ST na NF-e mesmo com CST 60 pepsControl: type: boolean description: Controla PEPS producedOnRelevantScale: type: boolean description: Produzido em escala relevante stockProduct: type: object properties: id: type: string description: format: uuid serialControl: type: boolean description: Controla por Série? batchControl: type: boolean description: Controla por Lote? validityControl: type: string description: Controle Validade measureUnit: #/definitions/measureUnit batchValidityDays: type: integer description: Dias Cálculo Validade Lote averagePrice: type: string description: Valor/Data Preço Médio averagePriceDate: type: string description: Data Preço Médio format: date canBeRequested: type: boolean description: Indicativo se o produto pode ser requisitado (movimento estoque) abcCurve: type: string description: Curva ABC abcCurveValue: type: string description: Curva ABC (Valor) abcCurveConsumptionQuantity: type: string description: Curva ABC (Consumo/Quantidade) abcCurveConsumptionValue: type: string description: Curva ABC (Consumo/Valor) costPrice: type: string description: Valor do preço de custo para entrada via produção purchaseProduct: type: object properties: id: type: string description: format: uuid canBePurchased: type: boolean description: Pode Ser Comprado? isLinkedToSupplier: type: boolean description: Indicativo se tem ligação com o fornecedor apportionmentProduct: type: object properties: id: type: string description: format: uuid expenseAccount: #/definitions/account revenueAccount: #/definitions/account inventoryLedgerAccount: #/definitions/account directCostAccount: #/definitions/account account5: #/definitions/account indirectCostAccount: #/definitions/account revenueFinancialAccount: #/definitions/financialAccount expenseFinancialAccount: #/definitions/financialAccount serviceitem: type: object required: – company – family – code – description – measureUnit properties: id: type: string description: format: uuid company: #/definitions/company family: #/definitions/family code: type: string description: Serviço description: type: string description: Descrição additionalDescription: type: string description: Complemento measureUnit: #/definitions/measureUnit standardQuantity: type: number description: Quantidade padrão format: double note: type: string description: Observação do serviço branch: #/definitions/branch shippingCompany: #/definitions/shippingCompany linkType: type: string description: Tipo de ligação tensionGroup: type: string description: Cód. do grupo de tensão energyClass: type: string description: Classe cons. energia/gás waterClass: type: string description: Classe fornec. Água maintenanceCategory: #/definitions/maintenanceCategory spendingNature: #/definitions/spendingNature purchasePrice: type: string description: Preço unitário do serviço para compras status: type: string description: Situação deleted: type: boolean description: Indica se o registro foi excluído commercialService: #/definitions/commercialService taxService: #/definitions/taxService apportionmentService: #/definitions/apportionmentService purchaseService: #/definitions/purchaseService maintenanceCategory: type: object properties: id: type: string description: format: uuid commercialService: type: object required: – invoiceDescription properties: id: type: string description: format: uuid invoiceDescription: type: string description: Descrição do serviço para impressão na nota fiscal serviceType: type: string description: Tipo de Serviço Comércio discountPercentage: type: number description: Percentual de desconto previsto para venda do serviço format: double commissionPercentage: type: number description: Percentual de comissão previsto para venda do serviço format: double taxService: type: object properties: id: type: string description: format: uuid taxCode: type: string description: Código fiscal taxDescription: type: string description: Descrição fiscal ncm: #/definitions/ncm law1162003: #/definitions/law1162003 nbs: #/definitions/nbs serviceActivityCode: type: string description: Código da atividade do item de serviço taxDevice: #/definitions/taxDevice taxOriginOfGoods: type: string description: Origem fiscal da mercadoria cest: type: string description: Especificador substituição tributária law1162003: type: object properties: id: type: string description: format: uuid nbs: type: object properties: id: type: string description: format: uuid taxDevice: type: object properties: id: type: string description: format: uuid apportionmentService: type: object properties: id: type: string description: format: uuid expenseAccount: #/definitions/account revenueAccount: #/definitions/account directCostAccount: #/definitions/account indirectCostAccount: #/definitions/account costCenter: #/definitions/costCenter revenueFinancialAccount: #/definitions/financialAccount expenseFinancialAccount: #/definitions/financialAccount costCenter: type: object properties: id: type: string description: format: uuid purchaseService: type: object properties: id: type: string description: format: uuid isLinkedToSupplier: type: boolean description: Indicativo se tem ligação com o fornecedor paymentTerms: type: object required: – company – code – description – abbreviation – application – installmentsQuantity – installmentsType – weekdayForDueDate – freightInFirstInstallment – insuranceInFirstInstallment – packagingInFirstInstallment – otherExpensesInFirstInstallment – ipiInFirstInstallment – icmsInFirstInstallment – icmsStInFirstInstallment – chargesInFirstInstallment – irrfInFirstInstallment – status properties: id: type: string description: format: uuid company: #/definitions/company code: type: string description: Código da condição de pagamento description: type: string description: Descrição da condição de pagamento abbreviation: type: string description: Abreviatura da condição de pagamento application: type: string description: Aplicação da condição de pagamento installmentsQuantity: type: integer description: Quantidade total de parcelas da condição de pagamento installmentsType: type: string description: Tipo de parcelas weekdayForDueDate: type: string description: Indicativo do dia da semana para vencimento parcelas averageDeadline: type: integer description: Prazo médio da condição de pagamento firstDayOfMonth: type: integer description: Primeiro dia especial do mês para vencimento das parcelas secondDayOfMonth: type: integer description: Segundo dia especial do mês para vencimento das parcelas thirdDayOfMonth: type: integer description: Terceiro dia especial do mês para vencimento das parcelas freightInFirstInstallment: type: boolean description: Indicativo se o valor total do frete deve estar na 1ª parcela insuranceInFirstInstallment: type: boolean description: Indicativo se o valor total do seguro deve estar na 1ª parcela packagingInFirstInstallment: type: boolean description: Indicativo se o valor total das embalagens deve estar na 1ª parcela otherExpensesInFirstInstallment: type: boolean description: Indicativo se o valor total das outras despesas deve estar na 1ª parcela ipiInFirstInstallment: type: boolean description: Indicativo se o valor total do IPI deve estar na 1ª parcela icmsInFirstInstallment: type: boolean description: Indicativo se o valor total do ICMS deve estar na 1ª parcela icmsStInFirstInstallment: type: boolean description: Indicativo se o valor total do ICMS substituído deve estar na 1ª parcela chargesInFirstInstallment: type: boolean description: Indicativo se o valor total dos encargos deve estar na 1ª parcela issInFirstInstallment: type: boolean description: Indicativo se o valor total do ISS deve estar na 1ª parcela irrfInFirstInstallment: type: boolean description: Indicativo se o valor total do irrf deve estar na 1ª parcela status: type: string description: Situação da condição de pagamento purchasePrice: type: number description: Preço Compra format: double fixedDueDay: type: boolean description: O dia do vencimento é fixo para períodos de 30 em 30 dias percentageForSalePrice: type: number description: Percentual para formação do preço de venda format: double percentageForCommission: type: number description: Percentual para formação da comissão do representante format: double commissionBasisReducer: type: number description: Percentual redutor do valor base comissão format: double feesCalculationType: type: string description: Tipo de cálculo aplicado sobre os juros feesPercentage: type: number description: Percentual de juros format: double anticipationDiscountPercentage: type: number description: Percentual de desconto por antecipação format: double punctualityDiscountPercentage: type: number description: Percentual de desconto por pontualidade format: double calculateFees: type: boolean description: Calcular juros desde a data de venda inssInFirstInstallment: type: boolean description: Deduzir INSS da 1ª parcela csrfInFirstInstallment: type: boolean description: Deduzir CSRF da 1ª parcela deleted: type: boolean description: Indica se o registro foi excluído paymentTermsInstallment: type: object required: – sequence – installmentQuantity properties: id: type: string description: format: uuid paymentTerms: #/definitions/paymentTerms sequence: type: integer description: Ordem sequencial para controle das parcelas installmentQuantity: type: integer description: Quantidade de parcelas daysBetweenInstallments: type: integer description: Quantidade de dias de intervalo entre as parcelas percentage: type: number description: Percentual do total a ser considera para a condição de pagamento format: double indicativeOfPaymentMethod: type: string description: Indicativo da forma de pagamento paymentMethod: #/definitions/paymentMethod deleted: type: boolean description: Indica se o registro foi excluído paymentMethod: type: object required: – company – code – description – abbreviation – paymentType – status properties: id: type: string description: format: uuid company: #/definitions/company code: type: integer description: Código forma pagamento description: type: string description: Descrição abbreviation: type: string description: Abreviatura paymentType: type: string description: Tipo pagamento status: type: string description: Situação deleted: type: boolean description: Indica se o registro foi excluído customerDefinition: type: object required: – customer – branch – commissionPercentage – discountPercentage properties: id: type: string description: format: uuid category: #/definitions/category paymentTerms: #/definitions/paymentTerms paymentMethod: #/definitions/paymentMethod salePurpose: #/definitions/salePurpose representative: #/definitions/representative customer: #/definitions/customer branch: #/definitions/branch shippingCompany: #/definitions/shippingCompany redispatchShippingCompany: #/definitions/shippingCompany freightType: type: string description: Tipo de frete finalCostumer: type: boolean description: Consumidor Final priceList: #/definitions/salePriceList consumerPresence: type: string description: Indicativo presencial do consumidor requireLinkBetweenCustomerAndProduct: type: boolean description: N Exige ligação cliente x produto billingAddress: #/definitions/address deliveryAddress: #/definitions/address allowOrderWithSameDeliveryDate: type: boolean description: Aceita pedido com a mesma data de entrega requireCustomerOrderNumber: type: boolean description: Exige número do pedido do cliente no pedido lastOrderDate: type: string description: Data do último pedido format: date lastOrderValue: type: string description: Valor do último pedido allowPartialInvoicing: type: boolean description: Aceita faturamento parcial de pedidos percentageInvoicingAbove: type: number description: Percentual de quantidade acima do pedido aceito no faturamento format: double commissionPercentage: type: number description: Percentual de comissão format: double discountPercentage: type: number description: Percentual de desconto format: double status: type: string description: Situação requireCustomerProduct: type: boolean description: Exige Produto Cliente no Pedido amountOfDueDays: type: integer description: Quantidade Dias Vencimento dueDayCriterion: type: string description: Critério Dia Vencimento weekdayForDueDate: type: string description: Dia Vencimento Semana firstDayOfMonthForDueDate: type: integer description: 1º Dia Especial Mês secondDayOfMonthForDueDate: type: integer description: 2º Dia Especial Mês thirdDayOfMonthForDueDate: type: integer description: 3º Dia Especial Mês deleted: type: boolean description: Excluído category: type: object properties: id: type: string description: format: uuid salePurpose: type: object properties: id: type: string description: format: uuid address: type: object properties: id: type: string description: format: uuid salePriceListValidity: type: object required: – description – initialDate – finalDate – pricePerQuantity – status properties: id: type: string description: format: uuid salePriceList: #/definitions/salePriceList description: type: string description: Descrição da validade initialDate: type: string description: Validade Inicial format: date finalDate: type: string description: Validade Final format: date pricePerQuantity: type: boolean description: Usa Preço por Quantidade discountPercentage: type: number description: % Desconto format: double commissionPercentage: type: number description: % Comissão format: double status: type: string description: Situação contact: type: object required: – person – name – title – visibility – status properties: id: type: string description: format: uuid person: #/definitions/person name: type: string description: Nome do contato type: string description: Nome de tratamento email: type: string description: E-mail phoneNumber: type: string description: Telefone phoneNumber2: type: string description: Telefone 2 cpf: type: string description: CPF visibility: type: string description: Visibilidade status: type: string description: Situação cep: #/definitions/cep address: type: string description: Endereço addressNumber: type: string description: Número do endereço addressComplement: type: string description: Complemento neighborhood: type: string description: Bairro city: #/definitions/city state: #/definitions/state note: type: string description: Observação salePriceListItem: type: object required: – itemType – maxAmount – basePrice – status properties: id: type: string description: format: uuid itemType: type: string description: Tipo do item salePriceListValidity: #/definitions/salePriceListValidity product: #/definitions/product serviceItem: #/definitions/serviceitem paymentTerms: #/definitions/paymentTerms measureUnit: #/definitions/measureUnit maxAmount: type: integer description: Até Quantidade basePrice: type: string description: Preço Base discountPercentage: type: number description: % Desconto format: double commissionPercentage: type: number description: % Comissão format: double note: type: string description: Observação status: type: string description: Situação genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE