diff --git a/docs/v1/index.yml b/docs/v1/index.yml index 108df4f..2a81f98 100644 --- a/docs/v1/index.yml +++ b/docs/v1/index.yml @@ -175,3 +175,39 @@ paths: $ref: sales/sales-return/sales-return_approval_send.yaml /sales/sales-return/approve: $ref: sales/sales-return/sales-return_approve_by_email.yaml + /purchase/return: + $ref: purchase/return/return.yaml + /purchase/return/{id}: + $ref: purchase/return/return_id.yaml + /purchase/return/{id}/approve: + $ref: purchase/return/return_id_approve.yaml + /purchase/return/{id}/reject: + $ref: purchase/return/return_id_reject.yaml + /purchase/return/{id}/cancellation-approve: + $ref: purchase/return/return_id_cancellation_approve.yaml + /purchase/return/{id}/cancellation-reject: + $ref: purchase/return/return_id_cancellation_reject.yaml + /purchase/return/{id}/histories: + $ref: purchase/return/return_id_histories.yaml + /purchase/return/approval: + $ref: purchase/return/return_approval.yaml + /purchase/return/approval/send: + $ref: purchase/return/return_approval_send.yaml + /purchase/payment-order: + $ref: purchase/payment-order/payment-order.yaml + /purchase/payment-order/{id}: + $ref: purchase/payment-order/payment-order_id.yaml + /purchase/payment-order/{id}/approve: + $ref: purchase/payment-order/payment-order_id_approve.yaml + /purchase/payment-order/{id}/reject: + $ref: purchase/payment-order/payment-order_id_reject.yaml + /purchase/payment-order/{id}/cancellation-approve: + $ref: purchase/payment-order/payment-order_id_cancellation_approve.yaml + /purchase/payment-order/{id}/cancellation-reject: + $ref: purchase/payment-order/payment-order_id_cancellation_reject.yaml + /purchase/payment-order/{id}/histories: + $ref: purchase/payment-order/payment-order_id_histories.yaml + /purchase/payment-order/approval: + $ref: purchase/payment-order/payment-order_approval.yaml + /purchase/payment-order/approval/send: + $ref: purchase/payment-order/payment-order_approval_send.yaml \ No newline at end of file diff --git a/docs/v1/purchase/payment-order/payment-order-references.yaml b/docs/v1/purchase/payment-order/payment-order-references.yaml new file mode 100644 index 0000000..f4ed96c --- /dev/null +++ b/docs/v1/purchase/payment-order/payment-order-references.yaml @@ -0,0 +1,100 @@ +get: + tags: + - Purchase Payment Order + summary: purchase payment order - references + parameters: + - name: supplierId + in: path + required: true + description: supplier id + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + properties: + data: + type: object + properties: + invoices: + type: array + items: + type: object + properties: + id: + type: integer + date: + type: string + number: + type: string + notes: + type: string + available: + type: number + downPayments: + type: array + items: + type: object + properties: + id: + type: integer + date: + type: string + number: + type: string + notes: + type: string + available: + type: number + returns: + type: array + items: + type: object + properties: + id: + type: integer + date: + type: string + number: + type: string + notes: + type: string + available: + type: number + example: + data: + invoices: + - id: 2 + date: '2022-06-19T04:21:10.000Z' + number: 'PI22060001' + notes: '' + available: 879900000 + - id: 3 + date: '2022-06-19T04:21:10.000Z' + number: 'PI22060002' + notes: '' + available: 11000000 + downPayments: + - id: 2 + date: '2022-06-19T04:21:10.000Z' + number: 'PDP22060001' + notes: '' + available: 5000000 + - id: 3 + date: '2022-06-19T04:21:10.000Z' + number: 'PDP22060002' + notes: '' + available: 5000000 + returns: + - id: 2 + date: '2022-06-19T04:21:10.000Z' + number: 'PRETURN22060001' + notes: '' + available: 30000 + - id: 3 + date: '2022-06-19T04:21:10.000Z' + number: 'PRETURN22060002' + notes: '' + available: 20000 \ No newline at end of file diff --git a/docs/v1/purchase/payment-order/payment-order.yaml b/docs/v1/purchase/payment-order/payment-order.yaml new file mode 100644 index 0000000..bbbc0d3 --- /dev/null +++ b/docs/v1/purchase/payment-order/payment-order.yaml @@ -0,0 +1,479 @@ +get: + tags: + - Purchase Payment Order + summary: purchase payment order - all + parameters: + - name: filter_approval + in: query + schema: + type: string + example: approved + - name: filter_form + in: query + schema: + type: string + example: done + - name: filter_like + in: query + schema: + type: string + example: '{"form.number": "PRETURN22120001"}' + - name: filter_date_min + in: query + schema: + type: string + example: '2022-05-01 00:00:00' + - name: filter_date_max + in: query + schema: + type: string + example: '2022-06-08 00:00:00' + - name: limit + in: query + schema: + type: integer + example: '10' + - name: page + in: query + schema: + type: integer + example: '1' + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + properties: + meta: + type: object + properties: + currentPage: + type: integer + lastPage: + type: integer + perPage: + type: integer + total: + type: integer + data: + type: array + items: + type: object + properties: + id: + type: integer + paymentType: + type: string + supplierId: + type: integer + supplierName: + type: string + amount: + type: integer + supplier: + type: object + properties: + id: + type: integer + code: + type: string + name: + type: string + address: + type: string + city: + type: string + state: + type: string + country: + type: string + phone: + type: string + email: + type: string + invoices: + type: array + items: + type: object + properties: + id: + type: integer + purchasePaymentOrderId: + type: integer + available: + type: integer + amount: + type: integer + referenceableId: + type: integer + referenceableType: + type: string + form: + type: object + properties: + date: + type: string + number: + type: string + notes: + type: string + downPayments: + type: array + items: + type: object + properties: + id: + type: integer + purchasePaymentOrderId: + type: integer + available: + type: integer + amount: + type: integer + referenceableId: + type: integer + referenceableType: + type: string + form: + type: object + properties: + date: + type: string + number: + type: string + notes: + type: string + returns: + type: array + items: + type: object + properties: + id: + type: integer + purchasePaymentOrderId: + type: integer + available: + type: integer + amount: + type: integer + referenceableId: + type: integer + referenceableType: + type: string + form: + type: object + properties: + date: + type: string + number: + type: string + notes: + type: string + others: + type: array + items: + type: object + properties: + id: + type: integer + purchasePaymentOrderId: + type: integer + amount: + type: integer + chartOfAccountId: + type: integer + allocationId: + type: integer + notes: + type: string + chartOfAccount: + type: object + properties: + id: + type: integer + number: + type: string + name: + type: string + alias: + type: string + allocation: + type: object + properties: + id: + type: integer + code: + type: string + name: + type: string + form: + type: object + properties: + id: + type: integer + branchId: + type: integer + date: + type: string + number: + type: string + editedNumber: + type: string + notes: + type: string + editedNotes: + type: string + createdBy: + type: integer + updatedBy: + type: integer + done: + type: boolean + incrementNumber: + type: integer + incrementGroup: + type: integer + formableId: + type: integer + formableType: + type: string + requestApprovalTo: + type: integer + approvalBy: + type: integer + approvalAt: + type: string + approvalReason: + type: string + approvalStatus: + type: integer + requestCancellationTo: + type: integer + requestCancellationBy: + type: integer + requestCancellationAt: + type: string + requestCancellationReason: + type: string + cancellationApprovalAt: + type: string + cancellationApprovalBy: + type: integer + cancellationApprovalReason: + type: string + cancellationStatus: + type: integer +post: + tags: + - Purchase Payment Order + summary: purchase payment order - create + requestBody: + content: + application/json: + schema: + type: object + required: + - paymentType + - supplierId + - date + - invoices + - requestApprovalTo + - totalInvoiceAmount + - totalDownPaymentAmount + - totalReturnAmount + - totalOtherAmount + - totalAmount + properties: + paymentType: + type: string + supplierId: + type: integer + date: + type: string + invoices: + type: array + items: + type: object + required: + - amount + properties: + id: + type: integer + amount: + type: integer + downPayments: + type: array + items: + type: object + required: + - amount + properties: + id: + type: integer + amount: + type: integer + returns: + type: array + items: + type: object + required: + - amount + properties: + id: + type: integer + amount: + type: integer + others: + type: array + items: + type: object + required: + - amount + - coaId + properties: + id: + type: integer + amount: + type: integer + coaId: + type: integer + notes: + type: string + allocationId: + type: integer + notes: + type: string + requestApprovalTo: + type: integer + totalInvoiceAmount: + type: integer + totalDownPaymentAmount: + type: integer + totalReturnAmount: + type: integer + totalOtherAmount: + type: integer + totalAmount: + type: integer + responses: + '201': + description: Created + content: + application/json: + schema: + type: object + properties: + data: + type: object + properties: + id: + type: integer + paymentType: + type: string + supplierId: + type: integer + supplierName: + type: string + amount: + type: integer + invoices: + type: array + items: + type: object + properties: + id: + type: integer + purchasePaymentOrderId: + type: integer + available: + type: integer + amount: + type: integer + referenceableId: + type: integer + referenceableType: + type: string + downPayments: + type: array + items: + type: object + properties: + id: + type: integer + purchasePaymentOrderId: + type: integer + available: + type: integer + amount: + type: integer + referenceableId: + type: integer + referenceableType: + type: string + returns: + type: array + items: + type: object + properties: + id: + type: integer + purchasePaymentOrderId: + type: integer + available: + type: integer + amount: + type: integer + referenceableId: + type: integer + referenceableType: + type: string + others: + type: array + items: + type: object + properties: + id: + type: integer + purchasePaymentOrderId: + type: integer + amount: + type: integer + chartOfAccountId: + type: integer + allocationId: + type: integer + notes: + type: string + form: + type: object + properties: + id: + type: integer + branchId: + type: integer + date: + type: string + number: + type: string + notes: + type: string + createdBy: + type: integer + updatedBy: + type: integer + done: + type: boolean + incrementNumber: + type: integer + incrementGroup: + type: integer + formableId: + type: integer + formableType: + type: string + requestApprovalTo: + type: integer + approvalStatus: + type: integer \ No newline at end of file diff --git a/docs/v1/purchase/payment-order/payment-order_approval.yaml b/docs/v1/purchase/payment-order/payment-order_approval.yaml new file mode 100644 index 0000000..f388b16 --- /dev/null +++ b/docs/v1/purchase/payment-order/payment-order_approval.yaml @@ -0,0 +1,247 @@ +get: + tags: + - Purchase Payment Order + summary: purchase payment order - approval all list + parameters: + - name: filter_like + in: query + schema: + type: string + example: '{"form.number": "PP22120001"}' + - name: limit + in: query + schema: + type: integer + example: '10' + - name: page + in: query + schema: + type: integer + example: '1' + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + properties: + meta: + type: object + properties: + currentPage: + type: integer + lastPage: + type: integer + perPage: + type: integer + total: + type: integer + data: + type: array + items: + type: object + properties: + id: + type: integer + paymentType: + type: string + supplierId: + type: integer + supplierName: + type: string + amount: + type: integer + supplier: + type: object + properties: + id: + type: integer + code: + type: string + name: + type: string + address: + type: string + city: + type: string + state: + type: string + country: + type: string + phone: + type: string + email: + type: string + invoices: + type: array + items: + type: object + properties: + id: + type: integer + purchasePaymentOrderId: + type: integer + available: + type: integer + amount: + type: integer + referenceableId: + type: integer + referenceableType: + type: string + form: + type: object + properties: + date: + type: string + number: + type: string + notes: + type: string + downPayments: + type: array + items: + type: object + properties: + id: + type: integer + purchasePaymentOrderId: + type: integer + available: + type: integer + amount: + type: integer + referenceableId: + type: integer + referenceableType: + type: string + form: + type: object + properties: + date: + type: string + number: + type: string + notes: + type: string + returns: + type: array + items: + type: object + properties: + id: + type: integer + purchasePaymentOrderId: + type: integer + available: + type: integer + amount: + type: integer + referenceableId: + type: integer + referenceableType: + type: string + form: + type: object + properties: + date: + type: string + number: + type: string + notes: + type: string + others: + type: array + items: + type: object + properties: + id: + type: integer + purchasePaymentOrderId: + type: integer + amount: + type: integer + chartOfAccountId: + type: integer + allocationId: + type: integer + notes: + type: string + chartOfAccount: + type: object + properties: + id: + type: integer + number: + type: string + name: + type: string + alias: + type: string + allocation: + type: object + properties: + id: + type: integer + code: + type: string + name: + type: string + form: + type: object + properties: + id: + type: integer + branchId: + type: integer + date: + type: string + number: + type: string + editedNumber: + type: string + notes: + type: string + editedNotes: + type: string + createdBy: + type: integer + updatedBy: + type: integer + done: + type: boolean + incrementNumber: + type: integer + incrementGroup: + type: integer + formableId: + type: integer + formableType: + type: string + requestApprovalTo: + type: integer + approvalBy: + type: integer + approvalAt: + type: string + approvalReason: + type: string + approvalStatus: + type: integer + requestCancellationTo: + type: integer + requestCancellationBy: + type: integer + requestCancellationAt: + type: string + requestCancellationReason: + type: string + cancellationApprovalAt: + type: string + cancellationApprovalBy: + type: integer + cancellationApprovalReason: + type: string + cancellationStatus: + type: integer \ No newline at end of file diff --git a/docs/v1/purchase/payment-order/payment-order_approval_send.yaml b/docs/v1/purchase/payment-order/payment-order_approval_send.yaml new file mode 100644 index 0000000..2366547 --- /dev/null +++ b/docs/v1/purchase/payment-order/payment-order_approval_send.yaml @@ -0,0 +1,39 @@ +post: + tags: + - Purchase Payment Order + summary: purchase payment order - send approval email + requestBody: + content: + application/json: + schema: + type: object + required: + - ids + properties: + ids: + type: array + items: + type: object + properties: + id: + type: integer + example: + ids: + - id: 14 + responses: + '200': + description: Successful response + content: + application/json: + schema: + type: object + required: + - ids + properties: + ids: + type: array + items: + type: object + properties: + id: + type: integer diff --git a/docs/v1/purchase/payment-order/payment-order_id.yaml b/docs/v1/purchase/payment-order/payment-order_id.yaml new file mode 100644 index 0000000..6d695af --- /dev/null +++ b/docs/v1/purchase/payment-order/payment-order_id.yaml @@ -0,0 +1,456 @@ +get: + tags: + - Purchase Payment Order + summary: purchase payment order - show + parameters: + - name: id + in: path + required: true + description: purchase payment order id + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + properties: + data: + type: object + properties: + id: + type: integer + paymentType: + type: string + supplierId: + type: integer + supplierName: + type: string + amount: + type: integer + supplier: + type: object + properties: + id: + type: integer + code: + type: string + name: + type: string + address: + type: string + city: + type: string + state: + type: string + country: + type: string + phone: + type: string + email: + type: string + invoices: + type: array + items: + type: object + properties: + id: + type: integer + purchasePaymentOrderId: + type: integer + available: + type: integer + amount: + type: integer + referenceableId: + type: integer + referenceableType: + type: string + form: + type: object + properties: + date: + type: string + number: + type: string + notes: + type: string + downPayments: + type: array + items: + type: object + properties: + id: + type: integer + purchasePaymentOrderId: + type: integer + available: + type: integer + amount: + type: integer + referenceableId: + type: integer + referenceableType: + type: string + form: + type: object + properties: + date: + type: string + number: + type: string + notes: + type: string + returns: + type: array + items: + type: object + properties: + id: + type: integer + purchasePaymentOrderId: + type: integer + available: + type: integer + amount: + type: integer + referenceableId: + type: integer + referenceableType: + type: string + form: + type: object + properties: + date: + type: string + number: + type: string + notes: + type: string + others: + type: array + items: + type: object + properties: + id: + type: integer + purchasePaymentOrderId: + type: integer + amount: + type: integer + chartOfAccountId: + type: integer + allocationId: + type: integer + notes: + type: string + chartOfAccount: + type: object + properties: + id: + type: integer + number: + type: string + name: + type: string + alias: + type: string + allocation: + type: object + properties: + id: + type: integer + code: + type: string + name: + type: string + form: + type: object + properties: + id: + type: integer + branchId: + type: integer + date: + type: string + number: + type: string + editedNumber: + type: string + notes: + type: string + editedNotes: + type: string + createdBy: + type: integer + updatedBy: + type: integer + done: + type: boolean + incrementNumber: + type: integer + incrementGroup: + type: integer + formableId: + type: integer + formableType: + type: string + requestApprovalTo: + type: integer + approvalBy: + type: integer + approvalAt: + type: string + approvalReason: + type: string + approvalStatus: + type: integer + requestCancellationTo: + type: integer + requestCancellationBy: + type: integer + requestCancellationAt: + type: string + requestCancellationReason: + type: string + cancellationApprovalAt: + type: string + cancellationApprovalBy: + type: integer + cancellationApprovalReason: + type: string + cancellationStatus: + type: integer +patch: + tags: + - Purchase Payment Order + summary: purchase payment order - update + parameters: + - name: id + in: path + required: true + schema: + type: integer + example: 1 + requestBody: + content: + application/json: + schema: + type: object + required: + - paymentType + - supplierId + - date + - invoices + - requestApprovalTo + - totalInvoiceAmount + - totalDownPaymentAmount + - totalReturnAmount + - totalOtherAmount + - totalAmount + properties: + paymentType: + type: string + supplierId: + type: integer + date: + type: string + invoices: + type: array + items: + type: object + required: + - amount + properties: + id: + type: integer + amount: + type: integer + downPayments: + type: array + items: + type: object + required: + - amount + properties: + id: + type: integer + amount: + type: integer + returns: + type: array + items: + type: object + required: + - amount + properties: + id: + type: integer + amount: + type: integer + others: + type: array + items: + type: object + required: + - amount + - coaId + properties: + id: + type: integer + amount: + type: integer + coaId: + type: integer + notes: + type: string + allocationId: + type: integer + notes: + type: string + requestApprovalTo: + type: integer + totalInvoiceAmount: + type: integer + totalDownPaymentAmount: + type: integer + totalReturnAmount: + type: integer + totalOtherAmount: + type: integer + totalAmount: + type: integer + responses: + '201': + description: Created + content: + application/json: + schema: + type: object + properties: + data: + type: object + properties: + id: + type: integer + paymentType: + type: string + supplierId: + type: integer + supplierName: + type: string + amount: + type: integer + invoices: + type: array + items: + type: object + properties: + id: + type: integer + purchasePaymentOrderId: + type: integer + available: + type: integer + amount: + type: integer + referenceableId: + type: integer + referenceableType: + type: string + downPayments: + type: array + items: + type: object + properties: + id: + type: integer + purchasePaymentOrderId: + type: integer + available: + type: integer + amount: + type: integer + referenceableId: + type: integer + referenceableType: + type: string + returns: + type: array + items: + type: object + properties: + id: + type: integer + purchasePaymentOrderId: + type: integer + available: + type: integer + amount: + type: integer + referenceableId: + type: integer + referenceableType: + type: string + others: + type: array + items: + type: object + properties: + id: + type: integer + purchasePaymentOrderId: + type: integer + amount: + type: integer + chartOfAccountId: + type: integer + allocationId: + type: integer + notes: + type: string + form: + type: object + properties: + id: + type: integer + branchId: + type: integer + date: + type: string + number: + type: string + notes: + type: string + createdBy: + type: integer + updatedBy: + type: integer + done: + type: boolean + incrementNumber: + type: integer + incrementGroup: + type: integer + formableId: + type: integer + formableType: + type: string + requestApprovalTo: + type: integer + approvalStatus: + type: integer +delete: + tags: + - Purchase Payment Order + summary: purchase payment order - delete + parameters: + - name: id + in: path + required: true + schema: + type: string + example: 1 + responses: + '204': + description: Deleted \ No newline at end of file diff --git a/docs/v1/purchase/payment-order/payment-order_id_approve.yaml b/docs/v1/purchase/payment-order/payment-order_id_approve.yaml new file mode 100644 index 0000000..d215e5a --- /dev/null +++ b/docs/v1/purchase/payment-order/payment-order_id_approve.yaml @@ -0,0 +1,86 @@ +post: + tags: + - Purchase Payment Order + summary: purchase payment order - approve + parameters: + - name: id + in: path + required: true + schema: + type: string + example: 1 + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + properties: + id: + type: integer + paymentType: + type: string + supplierId: + type: integer + supplierName: + type: string + amount: + type: integer + form: + type: object + properties: + id: + type: integer + branchId: + type: integer + date: + type: string + number: + type: string + editedNumber: + type: string + notes: + type: string + editedNotes: + type: string + createdBy: + type: integer + updatedBy: + type: integer + done: + type: boolean + incrementNumber: + type: integer + incrementGroup: + type: integer + formableId: + type: integer + formableType: + type: string + requestApprovalTo: + type: integer + approvalBy: + type: integer + approvalAt: + type: string + approvalReason: + type: string + approvalStatus: + type: integer + requestCancellationTo: + type: integer + requestCancellationBy: + type: integer + requestCancellationAt: + type: string + requestCancellationReason: + type: string + cancellationApprovalAt: + type: string + cancellationApprovalBy: + type: integer + cancellationApprovalReason: + type: string + cancellationStatus: + type: integer \ No newline at end of file diff --git a/docs/v1/purchase/payment-order/payment-order_id_cancellation_approve.yaml b/docs/v1/purchase/payment-order/payment-order_id_cancellation_approve.yaml new file mode 100644 index 0000000..908a374 --- /dev/null +++ b/docs/v1/purchase/payment-order/payment-order_id_cancellation_approve.yaml @@ -0,0 +1,86 @@ +post: + tags: + - Purchase Payment Order + summary: purchase payment order - cancellation approve + parameters: + - name: id + in: path + required: true + schema: + type: string + example: 1 + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + properties: + id: + type: integer + paymentType: + type: string + supplierId: + type: integer + supplierName: + type: string + amount: + type: integer + form: + type: object + properties: + id: + type: integer + branchId: + type: integer + date: + type: string + number: + type: string + editedNumber: + type: string + notes: + type: string + editedNotes: + type: string + createdBy: + type: integer + updatedBy: + type: integer + done: + type: boolean + incrementNumber: + type: integer + incrementGroup: + type: integer + formableId: + type: integer + formableType: + type: string + requestApprovalTo: + type: integer + approvalBy: + type: integer + approvalAt: + type: string + approvalReason: + type: string + approvalStatus: + type: integer + requestCancellationTo: + type: integer + requestCancellationBy: + type: integer + requestCancellationAt: + type: string + requestCancellationReason: + type: string + cancellationApprovalAt: + type: string + cancellationApprovalBy: + type: integer + cancellationApprovalReason: + type: string + cancellationStatus: + type: integer \ No newline at end of file diff --git a/docs/v1/purchase/payment-order/payment-order_id_cancellation_reject.yaml b/docs/v1/purchase/payment-order/payment-order_id_cancellation_reject.yaml new file mode 100644 index 0000000..0964f87 --- /dev/null +++ b/docs/v1/purchase/payment-order/payment-order_id_cancellation_reject.yaml @@ -0,0 +1,86 @@ +post: + tags: + - Purchase Payment Order + summary: purchase payment order - cancellation reject + parameters: + - name: id + in: path + required: true + schema: + type: string + example: 1 + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + properties: + id: + type: integer + paymentType: + type: string + supplierId: + type: integer + supplierName: + type: string + amount: + type: integer + form: + type: object + properties: + id: + type: integer + branchId: + type: integer + date: + type: string + number: + type: string + editedNumber: + type: string + notes: + type: string + editedNotes: + type: string + createdBy: + type: integer + updatedBy: + type: integer + done: + type: boolean + incrementNumber: + type: integer + incrementGroup: + type: integer + formableId: + type: integer + formableType: + type: string + requestApprovalTo: + type: integer + approvalBy: + type: integer + approvalAt: + type: string + approvalReason: + type: string + approvalStatus: + type: integer + requestCancellationTo: + type: integer + requestCancellationBy: + type: integer + requestCancellationAt: + type: string + requestCancellationReason: + type: string + cancellationApprovalAt: + type: string + cancellationApprovalBy: + type: integer + cancellationApprovalReason: + type: string + cancellationStatus: + type: integer \ No newline at end of file diff --git a/docs/v1/purchase/payment-order/payment-order_id_histories.yaml b/docs/v1/purchase/payment-order/payment-order_id_histories.yaml new file mode 100644 index 0000000..0b8b705 --- /dev/null +++ b/docs/v1/purchase/payment-order/payment-order_id_histories.yaml @@ -0,0 +1,62 @@ +get: + tags: + - Purchase Payment Order + summary: purchase payment order - show histories + parameters: + - name: id + in: path + required: true + schema: + type: string + example: 1 + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + properties: + meta: + type: object + properties: + currentPage: + type: integer + lastPage: + type: integer + perPage: + type: integer + total: + type: integer + data: + type: array + items: + type: object + properties: + id: + type: integer + tableType: + type: string + tableId: + type: integer + number: + type: string + date: + type: string + userId: + type: integer + activity: + type: string + formableId: + type: integer + user: + type: object + properties: + id: + type: integer + firstName: + type: string + lastName: + type: string + fullName: + type: string \ No newline at end of file diff --git a/docs/v1/purchase/payment-order/payment-order_id_reject.yaml b/docs/v1/purchase/payment-order/payment-order_id_reject.yaml new file mode 100644 index 0000000..078efe7 --- /dev/null +++ b/docs/v1/purchase/payment-order/payment-order_id_reject.yaml @@ -0,0 +1,86 @@ +post: + tags: + - Purchase Payment Order + summary: purchase payment order - reject + parameters: + - name: id + in: path + required: true + schema: + type: string + example: 1 + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + properties: + id: + type: integer + paymentType: + type: string + supplierId: + type: integer + supplierName: + type: string + amount: + type: integer + form: + type: object + properties: + id: + type: integer + branchId: + type: integer + date: + type: string + number: + type: string + editedNumber: + type: string + notes: + type: string + editedNotes: + type: string + createdBy: + type: integer + updatedBy: + type: integer + done: + type: boolean + incrementNumber: + type: integer + incrementGroup: + type: integer + formableId: + type: integer + formableType: + type: string + requestApprovalTo: + type: integer + approvalBy: + type: integer + approvalAt: + type: string + approvalReason: + type: string + approvalStatus: + type: integer + requestCancellationTo: + type: integer + requestCancellationBy: + type: integer + requestCancellationAt: + type: string + requestCancellationReason: + type: string + cancellationApprovalAt: + type: string + cancellationApprovalBy: + type: integer + cancellationApprovalReason: + type: string + cancellationStatus: + type: integer \ No newline at end of file diff --git a/docs/v1/purchase/return/return.yaml b/docs/v1/purchase/return/return.yaml new file mode 100644 index 0000000..4279370 --- /dev/null +++ b/docs/v1/purchase/return/return.yaml @@ -0,0 +1,400 @@ +get: + tags: + - Purchase Return + summary: purchase return - all + parameters: + - name: filter_approval + in: query + schema: + type: string + example: approved + - name: filter_form + in: query + schema: + type: string + example: done + - name: filter_like + in: query + schema: + type: string + example: '{"form.number": "PRETURN22120001"}' + - name: filter_date_min + in: query + schema: + type: string + example: '2022-05-01 00:00:00' + - name: filter_date_max + in: query + schema: + type: string + example: '2022-06-08 00:00:00' + - name: limit + in: query + schema: + type: integer + example: '10' + - name: page + in: query + schema: + type: integer + example: '1' + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + properties: + meta: + type: object + properties: + currentPage: + type: integer + lastPage: + type: integer + perPage: + type: integer + total: + type: integer + data: + type: array + items: + type: object + properties: + id: + type: integer + purchaseInvoiceId: + type: integer + warehouseId: + type: integer + supplierId: + type: integer + supplierName: + type: string + supplierAddress: + type: string + supplierPhone: + type: string + amount: + type: integer + tax: + type: integer + supplier: + type: object + properties: + id: + type: integer + code: + type: string + name: + type: string + address: + type: string + city: + type: string + state: + type: string + country: + type: string + phone: + type: string + email: + type: string + items: + type: array + items: + type: object + properties: + id: + type: integer + purchaseReturnId: + type: integer + purchaseInvoiceItemId: + type: integer + itemId: + type: integer + itemName: + type: string + expiryDate: + type: string + productionNumber: + type: string + quantityInvoice: + type: integer + quantity: + type: integer + price: + type: integer + discountPercent: + type: integer + discountValue: + type: integer + unit: + type: string + converter: + type: integer + notes: + type: string + allocationId: + type: integer + allocation: + type: object + properties: + id: + type: integer + name: + type: string + form: + type: object + properties: + id: + type: integer + branchId: + type: integer + date: + type: string + number: + type: string + editedNumber: + type: string + notes: + type: string + editedNotes: + type: string + createdBy: + type: integer + updatedBy: + type: integer + done: + type: boolean + incrementNumber: + type: integer + incrementGroup: + type: integer + formableId: + type: integer + formableType: + type: string + requestApprovalTo: + type: integer + approvalBy: + type: integer + approvalAt: + type: string + approvalReason: + type: string + approvalStatus: + type: integer + requestCancellationTo: + type: integer + requestCancellationBy: + type: integer + requestCancellationAt: + type: string + requestCancellationReason: + type: string + cancellationApprovalAt: + type: string + cancellationApprovalBy: + type: integer + cancellationApprovalReason: + type: string + cancellationStatus: + type: integer + purchaseInvoice: + type: object + properties: + id: + type: integer + form: + type: object + properties: + number: + type: string +post: + tags: + - Purchase Return + summary: purchase return - create + requestBody: + content: + application/json: + schema: + type: object + required: + - purchaseInvoiceId + - supplierId + - warehouseId + - date + - items + - requestApprovalTo + - typeOfTax + - taxBase + - tax + - amount + properties: + purchaseInvoiceId: + type: integer + supplierId: + type: integer + warehouseId: + type: integer + date: + type: string + items: + type: array + items: + type: object + required: + - purchaseInvoiceItemId + - itemId + - unit + - converter + - qtyInvoice + - quantity + - price + - discountValue + - total + properties: + purchaseInvoiceItemId: + type: integer + itemId: + type: integer + itemName: + type: string + expiryDate: + type: string + productionNumber: + type: string + notes: + type: string + unit: + type: string + converter: + type: integer + qtyInvoice: + type: integer + quantity: + type: integer + price: + type: integer + discountPercent: + type: integer + discountValue: + type: integer + total: + type: integer + allocationId: + type: integer + notes: + type: string + requestApprovalTo: + type: integer + subTotal: + type: integer + typeOfTax: + type: string + taxBase: + type: integer + tax: + type: integer + amount: + type: integer + responses: + '201': + description: Created + content: + application/json: + schema: + type: object + properties: + data: + type: object + properties: + id: + type: integer + purchaseInvoiceId: + type: integer + warehouseId: + type: integer + supplierId: + type: integer + supplierName: + type: string + supplierAddress: + type: string + supplierPhone: + type: string + amount: + type: integer + tax: + type: integer + items: + type: array + items: + type: object + properties: + id: + type: integer + purchaseReturnId: + type: integer + purchaseInvoiceItemId: + type: integer + itemId: + type: integer + itemName: + type: string + expiryDate: + type: string + productionNumber: + type: string + quantityInvoice: + type: integer + quantity: + type: integer + price: + type: integer + discountPercent: + type: integer + discountValue: + type: integer + unit: + type: string + converter: + type: integer + notes: + type: string + allocationId: + type: integer + form: + type: object + properties: + id: + type: integer + branchId: + type: integer + date: + type: string + number: + type: string + notes: + type: string + createdBy: + type: integer + updatedBy: + type: integer + done: + type: boolean + incrementNumber: + type: integer + incrementGroup: + type: integer + formableId: + type: integer + formableType: + type: string + requestApprovalTo: + type: integer + approvalStatus: + type: integer + diff --git a/docs/v1/purchase/return/return_approval.yaml b/docs/v1/purchase/return/return_approval.yaml new file mode 100644 index 0000000..9386519 --- /dev/null +++ b/docs/v1/purchase/return/return_approval.yaml @@ -0,0 +1,196 @@ +get: + tags: + - Purchase Return + summary: purchase return - approval all list + parameters: + - name: filter_like + in: query + schema: + type: string + example: '{"form.number": "PRETURN22120001"}' + - name: limit + in: query + schema: + type: integer + example: '10' + - name: page + in: query + schema: + type: integer + example: '1' + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + properties: + meta: + type: object + properties: + currentPage: + type: integer + lastPage: + type: integer + perPage: + type: integer + total: + type: integer + data: + type: array + items: + type: object + properties: + id: + type: integer + purchaseInvoiceId: + type: integer + warehouseId: + type: integer + supplierId: + type: integer + supplierName: + type: string + supplierAddress: + type: string + supplierPhone: + type: string + amount: + type: integer + tax: + type: integer + last_request_date: + type: string + supplier: + type: object + properties: + id: + type: integer + code: + type: string + name: + type: string + address: + type: string + city: + type: string + state: + type: string + country: + type: string + phone: + type: string + email: + type: string + items: + type: array + items: + type: object + properties: + id: + type: integer + purchaseReturnId: + type: integer + purchaseInvoiceItemId: + type: integer + itemId: + type: integer + itemName: + type: string + expiryDate: + type: string + productionNumber: + type: string + quantityInvoice: + type: integer + quantity: + type: integer + price: + type: integer + discountPercent: + type: integer + discountValue: + type: integer + unit: + type: string + converter: + type: integer + notes: + type: string + allocationId: + type: integer + allocation: + type: object + properties: + id: + type: integer + name: + type: string + form: + type: object + properties: + id: + type: integer + branchId: + type: integer + date: + type: string + number: + type: string + editedNumber: + type: string + notes: + type: string + editedNotes: + type: string + createdBy: + type: integer + updatedBy: + type: integer + done: + type: boolean + incrementNumber: + type: integer + incrementGroup: + type: integer + formableId: + type: integer + formableType: + type: string + requestApprovalTo: + type: integer + approvalBy: + type: integer + approvalAt: + type: string + approvalReason: + type: string + approvalStatus: + type: integer + requestCancellationTo: + type: integer + requestCancellationBy: + type: integer + requestCancellationAt: + type: string + requestCancellationReason: + type: string + cancellationApprovalAt: + type: string + cancellationApprovalBy: + type: integer + cancellationApprovalReason: + type: string + cancellationStatus: + type: integer + purchaseInvoice: + type: object + properties: + id: + type: integer + form: + type: object + properties: + number: + type: string \ No newline at end of file diff --git a/docs/v1/purchase/return/return_approval_send.yaml b/docs/v1/purchase/return/return_approval_send.yaml new file mode 100644 index 0000000..ea51e64 --- /dev/null +++ b/docs/v1/purchase/return/return_approval_send.yaml @@ -0,0 +1,39 @@ +post: + tags: + - Purchase Return + summary: purchase return - send approval email + requestBody: + content: + application/json: + schema: + type: object + required: + - ids + properties: + ids: + type: array + items: + type: object + properties: + id: + type: integer + example: + ids: + - id: 14 + responses: + '200': + description: Successful response + content: + application/json: + schema: + type: object + required: + - ids + properties: + ids: + type: array + items: + type: object + properties: + id: + type: integer diff --git a/docs/v1/purchase/return/return_id.yaml b/docs/v1/purchase/return/return_id.yaml new file mode 100644 index 0000000..a208378 --- /dev/null +++ b/docs/v1/purchase/return/return_id.yaml @@ -0,0 +1,414 @@ +get: + tags: + - Purchase Return + summary: purchase return - show + parameters: + - name: id + in: path + required: true + description: purchase return id + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + properties: + data: + type: object + properties: + id: + type: integer + purchaseInvoiceId: + type: integer + warehouseId: + type: integer + supplierId: + type: integer + supplierName: + type: string + supplierAddress: + type: string + supplierPhone: + type: string + amount: + type: integer + tax: + type: integer + supplier: + type: object + properties: + id: + type: integer + code: + type: string + name: + type: string + address: + type: string + city: + type: string + state: + type: string + country: + type: string + phone: + type: string + email: + type: string + items: + type: array + items: + type: object + properties: + id: + type: integer + purchaseReturnId: + type: integer + purchaseInvoiceItemId: + type: integer + itemId: + type: integer + itemName: + type: string + expiryDate: + type: string + productionNumber: + type: string + quantityInvoice: + type: integer + quantity: + type: integer + price: + type: integer + discountPercent: + type: integer + discountValue: + type: integer + unit: + type: string + converter: + type: integer + notes: + type: string + allocationId: + type: integer + allocation: + type: object + properties: + id: + type: integer + name: + type: string + form: + type: object + properties: + id: + type: integer + branchId: + type: integer + date: + type: string + number: + type: string + editedNumber: + type: string + notes: + type: string + editedNotes: + type: string + createdBy: + type: integer + updatedBy: + type: integer + done: + type: boolean + incrementNumber: + type: integer + incrementGroup: + type: integer + formableId: + type: integer + formableType: + type: string + requestApprovalTo: + type: integer + approvalBy: + type: integer + approvalAt: + type: string + approvalReason: + type: string + approvalStatus: + type: integer + requestCancellationTo: + type: integer + requestCancellationBy: + type: integer + requestCancellationAt: + type: string + requestCancellationReason: + type: string + cancellationApprovalAt: + type: string + cancellationApprovalBy: + type: integer + cancellationApprovalReason: + type: string + cancellationStatus: + type: integer + requesteApprovalToUser: + type: object + properties: + id: + type: integer + fullName: + type: string + name: + type: string + firstName: + type: string + lastName: + type: string + address: + type: string + phone: + type: string + email: + type: string + createdByUser: + type: object + properties: + id: + type: integer + fullName: + type: string + name: + type: string + firstName: + type: string + lastName: + type: string + address: + type: string + phone: + type: string + email: + type: string + purchaseInvoice: + type: object + properties: + id: + type: integer + form: + type: object + properties: + number: + type: string +patch: + tags: + - Purchase Return + summary: purchase return - update + parameters: + - name: id + in: path + required: true + schema: + type: integer + example: 1 + requestBody: + content: + application/json: + schema: + type: object + required: + - purchaseInvoiceId + - supplierId + - warehouseId + - date + - items + - requestApprovalTo + - typeOfTax + - taxBase + - tax + - amount + properties: + purchaseInvoiceId: + type: integer + supplierId: + type: integer + warehouseId: + type: integer + date: + type: string + items: + type: array + items: + type: object + required: + - purchaseInvoiceItemId + - itemId + - unit + - converter + - qtyInvoice + - quantity + - price + - discountValue + - total + properties: + purchaseInvoiceItemId: + type: integer + itemId: + type: integer + itemName: + type: string + expiryDate: + type: string + productionNumber: + type: string + notes: + type: string + unit: + type: string + converter: + type: integer + qtyInvoice: + type: integer + quantity: + type: integer + price: + type: integer + discountPercent: + type: integer + discountValue: + type: integer + total: + type: integer + allocationId: + type: integer + notes: + type: string + requestApprovalTo: + type: integer + subTotal: + type: integer + typeOfTax: + type: string + taxBase: + type: integer + tax: + type: integer + amount: + type: integer + responses: + '201': + description: Created + content: + application/json: + schema: + type: object + properties: + data: + type: object + properties: + id: + type: integer + purchaseInvoiceId: + type: integer + warehouseId: + type: integer + supplierId: + type: integer + supplierName: + type: string + supplierAddress: + type: string + supplierPhone: + type: string + amount: + type: integer + tax: + type: integer + items: + type: array + items: + type: object + properties: + id: + type: integer + purchaseReturnId: + type: integer + purchaseInvoiceItemId: + type: integer + itemId: + type: integer + itemName: + type: string + expiryDate: + type: string + productionNumber: + type: string + quantityInvoice: + type: integer + quantity: + type: integer + price: + type: integer + discountPercent: + type: integer + discountValue: + type: integer + unit: + type: string + converter: + type: integer + notes: + type: string + allocationId: + type: integer + form: + type: object + properties: + id: + type: integer + branchId: + type: integer + date: + type: string + number: + type: string + notes: + type: string + createdBy: + type: integer + updatedBy: + type: integer + done: + type: boolean + incrementNumber: + type: integer + incrementGroup: + type: integer + formableId: + type: integer + formableType: + type: string + requestApprovalTo: + type: integer + approvalStatus: + type: integer +delete: + tags: + - Purchase Return + summary: purchase return - delete + parameters: + - name: id + in: path + required: true + schema: + type: string + example: 1 + responses: + '204': + description: Deleted \ No newline at end of file diff --git a/docs/v1/purchase/return/return_id_approve.yaml b/docs/v1/purchase/return/return_id_approve.yaml new file mode 100644 index 0000000..0c16698 --- /dev/null +++ b/docs/v1/purchase/return/return_id_approve.yaml @@ -0,0 +1,94 @@ +post: + tags: + - Purchase Return + summary: purchase return - approve + parameters: + - name: id + in: path + required: true + schema: + type: string + example: 1 + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + properties: + id: + type: integer + purchaseInvoiceId: + type: integer + warehouseId: + type: integer + supplierId: + type: integer + supplierName: + type: string + supplierAddress: + type: string + supplierPhone: + type: string + amount: + type: integer + tax: + type: integer + form: + type: object + properties: + id: + type: integer + branchId: + type: integer + date: + type: string + number: + type: string + editedNumber: + type: string + notes: + type: string + editedNotes: + type: string + createdBy: + type: integer + updatedBy: + type: integer + done: + type: boolean + incrementNumber: + type: integer + incrementGroup: + type: integer + formableId: + type: integer + formableType: + type: string + requestApprovalTo: + type: integer + approvalBy: + type: integer + approvalAt: + type: string + approvalReason: + type: string + approvalStatus: + type: integer + requestCancellationTo: + type: integer + requestCancellationBy: + type: integer + requestCancellationAt: + type: string + requestCancellationReason: + type: string + cancellationApprovalAt: + type: string + cancellationApprovalBy: + type: integer + cancellationApprovalReason: + type: string + cancellationStatus: + type: integer \ No newline at end of file diff --git a/docs/v1/purchase/return/return_id_cancellation_approve.yaml b/docs/v1/purchase/return/return_id_cancellation_approve.yaml new file mode 100644 index 0000000..c0f7f35 --- /dev/null +++ b/docs/v1/purchase/return/return_id_cancellation_approve.yaml @@ -0,0 +1,94 @@ +post: + tags: + - Purchase Return + summary: purchase return - cancellation approve + parameters: + - name: id + in: path + required: true + schema: + type: string + example: 1 + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + properties: + id: + type: integer + purchaseInvoiceId: + type: integer + warehouseId: + type: integer + supplierId: + type: integer + supplierName: + type: string + supplierAddress: + type: string + supplierPhone: + type: string + amount: + type: integer + tax: + type: integer + form: + type: object + properties: + id: + type: integer + branchId: + type: integer + date: + type: string + number: + type: string + editedNumber: + type: string + notes: + type: string + editedNotes: + type: string + createdBy: + type: integer + updatedBy: + type: integer + done: + type: boolean + incrementNumber: + type: integer + incrementGroup: + type: integer + formableId: + type: integer + formableType: + type: string + requestApprovalTo: + type: integer + approvalBy: + type: integer + approvalAt: + type: string + approvalReason: + type: string + approvalStatus: + type: integer + requestCancellationTo: + type: integer + requestCancellationBy: + type: integer + requestCancellationAt: + type: string + requestCancellationReason: + type: string + cancellationApprovalAt: + type: string + cancellationApprovalBy: + type: integer + cancellationApprovalReason: + type: string + cancellationStatus: + type: integer \ No newline at end of file diff --git a/docs/v1/purchase/return/return_id_cancellation_reject.yaml b/docs/v1/purchase/return/return_id_cancellation_reject.yaml new file mode 100644 index 0000000..ab79325 --- /dev/null +++ b/docs/v1/purchase/return/return_id_cancellation_reject.yaml @@ -0,0 +1,94 @@ +post: + tags: + - Purchase Return + summary: purchase return - cancellation reject + parameters: + - name: id + in: path + required: true + schema: + type: string + example: 1 + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + properties: + id: + type: integer + purchaseInvoiceId: + type: integer + warehouseId: + type: integer + supplierId: + type: integer + supplierName: + type: string + supplierAddress: + type: string + supplierPhone: + type: string + amount: + type: integer + tax: + type: integer + form: + type: object + properties: + id: + type: integer + branchId: + type: integer + date: + type: string + number: + type: string + editedNumber: + type: string + notes: + type: string + editedNotes: + type: string + createdBy: + type: integer + updatedBy: + type: integer + done: + type: boolean + incrementNumber: + type: integer + incrementGroup: + type: integer + formableId: + type: integer + formableType: + type: string + requestApprovalTo: + type: integer + approvalBy: + type: integer + approvalAt: + type: string + approvalReason: + type: string + approvalStatus: + type: integer + requestCancellationTo: + type: integer + requestCancellationBy: + type: integer + requestCancellationAt: + type: string + requestCancellationReason: + type: string + cancellationApprovalAt: + type: string + cancellationApprovalBy: + type: integer + cancellationApprovalReason: + type: string + cancellationStatus: + type: integer \ No newline at end of file diff --git a/docs/v1/purchase/return/return_id_histories.yaml b/docs/v1/purchase/return/return_id_histories.yaml new file mode 100644 index 0000000..996ec96 --- /dev/null +++ b/docs/v1/purchase/return/return_id_histories.yaml @@ -0,0 +1,62 @@ +get: + tags: + - Purchase Return + summary: purchase return - show histories + parameters: + - name: id + in: path + required: true + schema: + type: string + example: 1 + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + properties: + meta: + type: object + properties: + currentPage: + type: integer + lastPage: + type: integer + perPage: + type: integer + total: + type: integer + data: + type: array + items: + type: object + properties: + id: + type: integer + tableType: + type: string + tableId: + type: integer + number: + type: string + date: + type: string + userId: + type: integer + activity: + type: string + formableId: + type: integer + user: + type: object + properties: + id: + type: integer + firstName: + type: string + lastName: + type: string + fullName: + type: string \ No newline at end of file diff --git a/docs/v1/purchase/return/return_id_reject.yaml b/docs/v1/purchase/return/return_id_reject.yaml new file mode 100644 index 0000000..dd5e85f --- /dev/null +++ b/docs/v1/purchase/return/return_id_reject.yaml @@ -0,0 +1,94 @@ +post: + tags: + - Purchase Return + summary: purchase return - reject + parameters: + - name: id + in: path + required: true + schema: + type: string + example: 1 + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + properties: + id: + type: integer + purchaseInvoiceId: + type: integer + warehouseId: + type: integer + supplierId: + type: integer + supplierName: + type: string + supplierAddress: + type: string + supplierPhone: + type: string + amount: + type: integer + tax: + type: integer + form: + type: object + properties: + id: + type: integer + branchId: + type: integer + date: + type: string + number: + type: string + editedNumber: + type: string + notes: + type: string + editedNotes: + type: string + createdBy: + type: integer + updatedBy: + type: integer + done: + type: boolean + incrementNumber: + type: integer + incrementGroup: + type: integer + formableId: + type: integer + formableType: + type: string + requestApprovalTo: + type: integer + approvalBy: + type: integer + approvalAt: + type: string + approvalReason: + type: string + approvalStatus: + type: integer + requestCancellationTo: + type: integer + requestCancellationBy: + type: integer + requestCancellationAt: + type: string + requestCancellationReason: + type: string + cancellationApprovalAt: + type: string + cancellationApprovalBy: + type: integer + cancellationApprovalReason: + type: string + cancellationStatus: + type: integer \ No newline at end of file