Jump to

• Request
• Response

Retrieves the List Of Invoices for Netting Transactions

get

/service/v1/getNettingTxnInvoices

This endpoint is used to get the List Of Invoices for Netting Transactions.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• identifier(optional): string
  Invoice Transaction Identifier
• limit(optional): integer
  Limit is maximum no of records to be fetched
• nettingStatus(optional): string
  Invoice Transaction Status
• nettingTxnNo: string
  Back Office Reference No of Netting Txn
• offset(optional): integer
  Offset is starting no of records to be fetched

Header Parameters

• appId: string
  Source Application Id
• branchCode: string
  Branch Code
• userId: string
  Source user Id

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Successfully performs the operation

Body ()

Root Schema : InvoicesTransactionCollection

Type: object

Show Source

• errors(optional): array errors
• message(optional): string
• paging(optional): object PagingDto
  Paging DTO object
• payableDto(optional): array payableDto
• receivableDto(optional): array receivableDto
• responseStatus(optional): string

{
    "type":"object",
    "properties":{
        "receivableDto":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/NettingInvoicesModel"
            }
        },
        "payableDto":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/NettingInvoicesModel"
            }
        },
        "paging":{
            "description":"Paging DTO Model",
            "$ref":"#/definitions/PagingDto"
        },
        "responseStatus":{
            "type":"string"
        },
        "message":{
            "type":"string"
        },
        "errors":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ErrorDTO"
            }
        }
    }
}

Nested Schema : errors

Type: array

Show Source

• Array of: object ErrorDTO
  Put API Netting Transactions Status Update Errors

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

Nested Schema : PagingDto

Type: object

Paging DTO object

Show Source

• totalResults(optional): integer
  Total Results

{
    "description":"Paging DTO object",
    "type":"object",
    "properties":{
        "totalResults":{
            "description":"Total Results",
            "type":"integer"
        }
    }
}

Nested Schema : payableDto

Type: array

Show Source

• Array of: object NettingInvoicesModel

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

Nested Schema : receivableDto

Type: array

Show Source

• Array of: object NettingInvoicesModel

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

Nested Schema : ErrorDTO

Type: object

Put API Netting Transactions Status Update Errors

Show Source

• errorCode(optional): string
  Error Code
• errorDesc(optional): string
  Error Description

{
    "description":"Put API Netting Transactions Status Update Errors",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error Code"
        },
        "errorDesc":{
            "type":"string",
            "description":"Error Description"
        }
    }
}

Nested Schema : NettingInvoicesModel

Type: object

Show Source

• id(optional): string
  Id
• identifier(optional): string
  Identifier For Receivable or Payable
• invoiceAmount(optional): number
  Invoice Amount
• invoiceCcy(optional): string
  Invoice Currency
• invoiceRefNo(optional): string
  Invoice Ref No
• invoiceStatus(optional): string
  Invoice Status
• nettedInvAmount(optional): number
  Netted Inv Amount
• nettingStatus(optional): string
  Invoice Netting Status
• nettingTxnNo(optional): string
  Netting Transaction Number
• outStandingAmount(optional): number
  Invoice OutStanding Amount
• paymentDueDate(optional): string
  Invoice Payment Due Date
• paymentStatus(optional): string
  Invoice Payment Status
• remainingOutStandingAmount(optional): number
  Remaining Out Standing Amount
• sourceRefNo(optional): string
  Source Ref No

{
    "properties":{
        "id":{
            "type":"string",
            "description":"Id"
        },
        "nettingTxnNo":{
            "type":"string",
            "description":"Netting Transaction Number"
        },
        "sourceRefNo":{
            "type":"string",
            "description":"Source Ref No"
        },
        "identifier":{
            "type":"string",
            "description":"Identifier For Receivable or Payable"
        },
        "invoiceRefNo":{
            "type":"string",
            "description":"Invoice Ref No"
        },
        "invoiceStatus":{
            "type":"string",
            "description":"Invoice Status"
        },
        "paymentStatus":{
            "type":"string",
            "description":"Invoice Payment Status"
        },
        "nettingStatus":{
            "type":"string",
            "description":"Invoice Netting Status"
        },
        "outStandingAmount":{
            "type":"number",
            "description":"Invoice OutStanding Amount"
        },
        "invoiceAmount":{
            "type":"number",
            "description":"Invoice Amount"
        },
        "paymentDueDate":{
            "type":"string",
            "description":"Invoice Payment Due Date"
        },
        "nettedInvAmount":{
            "type":"number",
            "description":"Netted Inv Amount"
        },
        "remainingOutStandingAmount":{
            "type":"number",
            "description":"Remaining Out Standing Amount"
        },
        "invoiceCcy":{
            "type":"string",
            "description":"Invoice Currency"
        }
    }
}

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