Jump to

• Request
• Response

Filters the payment terms by given input parameters

post

/service/v1/filter

This endpoint is used for filter the payment terms by given input parameters.

Request

Supported Media Types

• application/json
• application/xml

Header Parameters

• appId: string
• branchCode: string
  branchCode
• userId: string
  userId

Body ()

Request body of invoice type

Root Schema : InvoiceFilterModel

Type: object

Invoice model

Show Source

• buyerCode(optional): string
• buyerDivCode(optional): string
  buyerDivCode
• buyerDivName(optional): string
• buyerId(optional): string
  buyerId
• buyerName(optional): string
  buyerName
• divisionCode(optional): string
• id(optional): string
• invoiceDate(optional): string
  invoiceDate
• invoiceDueDate(optional): string
  invoiceDueDate
• invoiceId(optional): string
  Id of the Invoice
• invoiceNumber(optional): string
  invoiceNumber
• invoiceRefNo(optional): string
  invoiceRefNo
• paymentDate(optional): string
• paymentTerms(optional): string
• programCode(optional): string
  programCode
• programName(optional): string
• reasonCode(optional): string
  reasonCode
• relationCode(optional): string
  relationCode
• seqNo(optional): integer(int64)
• shipmentDate(optional): string
• supplierCode(optional): string
• supplierDivCode(optional): string
  supplierDivCode
• supplierDivName(optional): string
  supplierDivName
• supplierId(optional): string
  supplierId
• supplierName(optional): string
  supplierName
• transactionRefNo(optional): string

{
    "description":"Invoice model",
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "seqNo":{
            "type":"integer",
            "format":"int64"
        },
        "invoiceId":{
            "description":"Id of the Invoice ",
            "type":"string"
        },
        "buyerId":{
            "type":"string",
            "description":"buyerId"
        },
        "buyerName":{
            "type":"string",
            "description":"buyerName"
        },
        "invoiceDate":{
            "type":"string",
            "description":"invoiceDate"
        },
        "invoiceDueDate":{
            "type":"string",
            "description":"invoiceDueDate"
        },
        "invoiceNumber":{
            "type":"string",
            "description":"invoiceNumber"
        },
        "invoiceRefNo":{
            "type":"string",
            "description":"invoiceRefNo"
        },
        "programCode":{
            "type":"string",
            "description":"programCode"
        },
        "programName":{
            "type":"string"
        },
        "reasonCode":{
            "type":"string",
            "description":"reasonCode"
        },
        "supplierId":{
            "type":"string",
            "description":"supplierId"
        },
        "supplierName":{
            "type":"string",
            "description":"supplierName"
        },
        "supplierDivCode":{
            "type":"string",
            "description":"supplierDivCode"
        },
        "supplierDivName":{
            "type":"string",
            "description":"supplierDivName"
        },
        "paymentTerms":{
            "type":"string"
        },
        "shipmentDate":{
            "type":"string"
        },
        "divisionCode":{
            "type":"string"
        },
        "transactionRefNo":{
            "type":"string"
        },
        "relationCode":{
            "type":"string",
            "description":"relationCode"
        },
        "supplierCode":{
            "type":"string"
        },
        "buyerCode":{
            "type":"string"
        },
        "paymentDate":{
            "type":"string"
        },
        "buyerDivCode":{
            "type":"string",
            "description":"buyerDivCode"
        },
        "buyerDivName":{
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Returns the paymentTerms based on given id.

Body ()

Root Schema : ObPaymentTermsCollection

Type: object

Collection of termstm.

Show Source

• data(optional): array data
• paging(optional): object PagingDto

{
    "description":"Collection of termstm.",
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ObPaymentTermsDTO"
            }
        },
        "paging":{
            "$ref":"#/definitions/PagingDto"
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object ObPaymentTermsDTO

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ObPaymentTermsDTO"
    }
}

Nested Schema : PagingDto

Type: object

Show Source

• totalResults(optional): integer

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer"
        }
    }
}

Nested Schema : ObPaymentTermsDTO

Type: object

Match All

Show Source

• allOf GenericDto
• object ObPaymentTermsDTO-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "id":{
                    "type":"string",
                    "description":"id"
                },
                "daysOfTheMonth":{
                    "type":"string",
                    "description":"daysOfTheMonth"
                },
                "daysOfTheWeek":{
                    "type":"string",
                    "description":"daysOfTheWeek"
                },
                "filterAttr1":{
                    "description":"filterAttr1",
                    "type":"string"
                },
                "filterAttr1Name":{
                    "type":"string",
                    "description":"filterAttr1Name"
                },
                "filterAttr2":{
                    "description":"filterAttr2",
                    "type":"string"
                },
                "filterAttr2Name":{
                    "type":"string",
                    "description":"filterAttr2Name"
                },
                "filterAttr3":{
                    "description":"filterAttr3",
                    "type":"string"
                },
                "filterAttr3Name":{
                    "type":"string",
                    "description":"filterAttr3Name"
                },
                "filterAttr4":{
                    "description":"filterAttr4",
                    "type":"string"
                },
                "filterAttr4Name":{
                    "type":"string",
                    "description":"filterAttr4Name"
                },
                "filterAttr5":{
                    "description":"filterAttr5",
                    "type":"string"
                },
                "filterAttr5Name":{
                    "type":"string",
                    "description":"filterAttr5Name"
                },
                "filterAttr6":{
                    "description":"filterAttr6",
                    "type":"string"
                },
                "filterAttr6Name":{
                    "type":"string",
                    "description":"filterAttr6Name"
                },
                "filterAttr7":{
                    "description":"filterAttr7",
                    "type":"string"
                },
                "filterAttr7Name":{
                    "type":"string",
                    "description":"filterAttr7Name"
                },
                "filterAttr8":{
                    "description":"filterAttr8",
                    "type":"string"
                },
                "filterAttr8Name":{
                    "type":"string",
                    "description":"filterAttr8Name"
                },
                "filterAttr9":{
                    "description":"filterAttr9",
                    "type":"string"
                },
                "filterAttr9Name":{
                    "type":"string",
                    "description":"filterAttr9Name"
                },
                "filterAttr10":{
                    "description":"filterAttr10",
                    "type":"string"
                },
                "filterAttr10Name":{
                    "type":"string",
                    "description":"filterAttr10Name"
                },
                "filterCriteria":{
                    "type":"string",
                    "description":"filterCriteria"
                },
                "frequencyOfPayments":{
                    "type":"string",
                    "description":"frequencyOfPayments"
                },
                "holidayTreatment":{
                    "type":"string",
                    "description":"holidayTreatment"
                },
                "minimumCreditPeriod":{
                    "type":"number",
                    "description":"minimumCreditPeriod"
                },
                "paymentDateCalculationBasis":{
                    "type":"string",
                    "description":"paymentDateCalculationBasis"
                },
                "txnControllerRefNo":{
                    "type":"string",
                    "description":"txnControllerRefNo"
                },
                "applicationCode":{
                    "type":"string",
                    "description":"applicationCode"
                },
                "ObPaymentCustomTermsDTO":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/ObPaymentCustomTermsDTO"
                    }
                }
            }
        }
    ]
}

Nested Schema : GenericDto

Match All

Show Source

• object GenericDto-allOf[0]
  Discriminator: resource_type

{
    "allOf":[
        {
            "type":"object",
            "discriminator":"resource_type"
        }
    ]
}

Nested Schema : GenericDto-allOf[0]

Type: object

Discriminator: resource_type

Nested Schema : ObPaymentTermsDTO-allOf[1]

Type: object

Show Source

• applicationCode(optional): string
  applicationCode
• daysOfTheMonth(optional): string
  daysOfTheMonth
• daysOfTheWeek(optional): string
  daysOfTheWeek
• filterAttr1(optional): string
  filterAttr1
• filterAttr10(optional): string
  filterAttr10
• filterAttr10Name(optional): string
  filterAttr10Name
• filterAttr1Name(optional): string
  filterAttr1Name
• filterAttr2(optional): string
  filterAttr2
• filterAttr2Name(optional): string
  filterAttr2Name
• filterAttr3(optional): string
  filterAttr3
• filterAttr3Name(optional): string
  filterAttr3Name
• filterAttr4(optional): string
  filterAttr4
• filterAttr4Name(optional): string
  filterAttr4Name
• filterAttr5(optional): string
  filterAttr5
• filterAttr5Name(optional): string
  filterAttr5Name
• filterAttr6(optional): string
  filterAttr6
• filterAttr6Name(optional): string
  filterAttr6Name
• filterAttr7(optional): string
  filterAttr7
• filterAttr7Name(optional): string
  filterAttr7Name
• filterAttr8(optional): string
  filterAttr8
• filterAttr8Name(optional): string
  filterAttr8Name
• filterAttr9(optional): string
  filterAttr9
• filterAttr9Name(optional): string
  filterAttr9Name
• filterCriteria(optional): string
  filterCriteria
• frequencyOfPayments(optional): string
  frequencyOfPayments
• holidayTreatment(optional): string
  holidayTreatment
• id(optional): string
  id
• minimumCreditPeriod(optional): number
  minimumCreditPeriod
• ObPaymentCustomTermsDTO(optional): array ObPaymentCustomTermsDTO
• paymentDateCalculationBasis(optional): string
  paymentDateCalculationBasis
• txnControllerRefNo(optional): string
  txnControllerRefNo

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id"
        },
        "daysOfTheMonth":{
            "type":"string",
            "description":"daysOfTheMonth"
        },
        "daysOfTheWeek":{
            "type":"string",
            "description":"daysOfTheWeek"
        },
        "filterAttr1":{
            "description":"filterAttr1",
            "type":"string"
        },
        "filterAttr1Name":{
            "type":"string",
            "description":"filterAttr1Name"
        },
        "filterAttr2":{
            "description":"filterAttr2",
            "type":"string"
        },
        "filterAttr2Name":{
            "type":"string",
            "description":"filterAttr2Name"
        },
        "filterAttr3":{
            "description":"filterAttr3",
            "type":"string"
        },
        "filterAttr3Name":{
            "type":"string",
            "description":"filterAttr3Name"
        },
        "filterAttr4":{
            "description":"filterAttr4",
            "type":"string"
        },
        "filterAttr4Name":{
            "type":"string",
            "description":"filterAttr4Name"
        },
        "filterAttr5":{
            "description":"filterAttr5",
            "type":"string"
        },
        "filterAttr5Name":{
            "type":"string",
            "description":"filterAttr5Name"
        },
        "filterAttr6":{
            "description":"filterAttr6",
            "type":"string"
        },
        "filterAttr6Name":{
            "type":"string",
            "description":"filterAttr6Name"
        },
        "filterAttr7":{
            "description":"filterAttr7",
            "type":"string"
        },
        "filterAttr7Name":{
            "type":"string",
            "description":"filterAttr7Name"
        },
        "filterAttr8":{
            "description":"filterAttr8",
            "type":"string"
        },
        "filterAttr8Name":{
            "type":"string",
            "description":"filterAttr8Name"
        },
        "filterAttr9":{
            "description":"filterAttr9",
            "type":"string"
        },
        "filterAttr9Name":{
            "type":"string",
            "description":"filterAttr9Name"
        },
        "filterAttr10":{
            "description":"filterAttr10",
            "type":"string"
        },
        "filterAttr10Name":{
            "type":"string",
            "description":"filterAttr10Name"
        },
        "filterCriteria":{
            "type":"string",
            "description":"filterCriteria"
        },
        "frequencyOfPayments":{
            "type":"string",
            "description":"frequencyOfPayments"
        },
        "holidayTreatment":{
            "type":"string",
            "description":"holidayTreatment"
        },
        "minimumCreditPeriod":{
            "type":"number",
            "description":"minimumCreditPeriod"
        },
        "paymentDateCalculationBasis":{
            "type":"string",
            "description":"paymentDateCalculationBasis"
        },
        "txnControllerRefNo":{
            "type":"string",
            "description":"txnControllerRefNo"
        },
        "applicationCode":{
            "type":"string",
            "description":"applicationCode"
        },
        "ObPaymentCustomTermsDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ObPaymentCustomTermsDTO"
            }
        }
    }
}

Nested Schema : ObPaymentCustomTermsDTO

Type: array

Show Source

• Array of: object ObPaymentCustomTermsDTO

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ObPaymentCustomTermsDTO"
    }
}

Nested Schema : ObPaymentCustomTermsDTO

Type: object

Show Source

• fromDay(optional): string
  FromDay for Custom payment Terms
• id(optional): string
  Id for Custom payment Terms
• paymentDay(optional): string
  PaymentDay for Custom payment Terms
• paymentTermsId(optional): string
  PaymentTermsId for Custom payment Terms
• toDay(optional): string
  ToDay for Custom payment Terms

{
    "type":"object",
    "properties":{
        "fromDay":{
            "type":"string",
            "description":"FromDay for Custom payment Terms"
        },
        "id":{
            "type":"string",
            "description":"Id for Custom payment Terms"
        },
        "paymentDay":{
            "type":"string",
            "description":"PaymentDay for Custom payment Terms"
        },
        "paymentTermsId":{
            "type":"string",
            "description":"PaymentTermsId for Custom payment Terms"
        },
        "toDay":{
            "type":"string",
            "description":"ToDay for Custom payment Terms"
        }
    }
}

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

500 Response

Internal error

Back to Top